A chart shows numeric information in a visual format. The tags available for the four chart types are shown in the following tables.
Bar Chart Tags
|
Tag |
Examples |
Status |
Notes |
|---|---|---|---|
| bar-chart |
bar-chart { ... } |
Required | Defines the block for this bar chart instance. |
| background-color | background-color "ff0000" | Optional | Sets the background color for the chart. Uses a hexadecimal code to identify colors. |
| bar | bar column = "Cases" | Required |
Names the summary column to display in the chart. A bar chart can have one to many summary columns. NOTE: Unlike tabular pages, chart columns do not change color when links are in use. |
| cplan | cplan "/cplans/basic_101.cplan" | Optional |
Indicates the data source. Can include filters. If a cPlan is not defined, the chart uses the cPlan that is used by the page that calls the chart. |
| dimension | dimension "Posting Period" | Required | Names the dimension to display in the chart. Charts can only have one dimension. |
| first | first 10 | Optional |
Identifies how many summary values appear in the chart. If this tag is omitted, the entire data set is displayed. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
| hide-legend | hide-legend | Optional | Indicates that the legend does not appear on the chart. |
| id |
bar-chart id = "bar" { ... } |
Optional | Provides a means to refer to this bar-chart block. |
| legend-location |
legend-location "top" legend-location "bottom" legend-location "left" legend-location "right" |
Optional |
Identifies the location of the legend: top, bottom, left, or right. By default, the legend is on the right side of the chart. |
| no-sort | no-sort | Optional | Specifies that the column information is not sorted. |
| percent |
percent = 50 percent = 85 |
Optional |
Identifies the percentage of the display layout allocated for the element. The percent is relative, meaning if the page area is already subdivided, the element gets a percentage of that subdivided space. NOTE: The total percentage must equal 100. |
| sort-column |
sort-column "Cases" sort-column "Cases" reverse = true |
Optional |
Specifies a column to sort on. Using reverse = true sorts in the opposite direction. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
| title | title "Bar Chart" | Optional | Indicates a title for the chart. |
| title-justification |
title-justification "left" title-justification "right" title-justification "center" |
Optional | Aligns the title of the chart to the left, right, or center. By default, the chart title is justified to the center of the title bar. |
H Bar Chart Tags
|
Tag |
Examples |
Status |
Notes |
|---|---|---|---|
| hbar-chart |
hbar-chart { ... } |
Required | Defines the block for this hbar chart instance. |
| bar | bar column = "Cases" | Required |
Names the summary columns to display in the chart. An hbar chart can have one to many summary columns. NOTE: Unlike tabular pages, chart columns do not change color when links are in use. |
| cplan | cplan "/cplans/basic_101.cplan" | Optional |
Indicates the data source. Can include filters. If a cPlan is not defined, the chart uses the cPlan that is used by the page that calls the chart. |
| data-labels | data-labels | Optional | Labels the horizontal bars with their numerical values. |
| dimension | dimension "Posting Period" | Required | Names the dimension to display in the chart. Charts can only have one dimension. |
| first | first 10 | Optional |
Identifies how many summary values appear in the chart. If this tag is omitted, the entire data set is displayed. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
| hide-legend | hide-legend | Optional | Indicates that the legend does not appear on the chart. |
| id |
hbar-chart id = "hbar" { ... } |
Optional | Provides a means to refer to this hbar-chart block. |
| legend-location |
legend-location "top" legend-location "bottom" legend-location "left" legend-location "right" |
Optional |
Identifies the location of the legend: top, bottom, left, or right. By default, the legend is on the right side of the chart. |
| no-sort | no-sort | Optional | Specifies that the column information is not sorted. |
| percent | percent = 30 | Optional | Identifies the percentage of the display layout allocated for the element. The percent is relative, meaning if the page area is already subdivided, the element gets a percentage of that subdivided space. |
| sort-column |
sort-column "Cases" sort-column "Cases" reverse = true |
Optional |
Specifies a column to sort on. Using reverse = true sorts in the opposite direction. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
Line Chart Tags
|
Tag |
Examples |
Status |
Notes |
|---|---|---|---|
| line-chart |
line-chart { ... } |
Required | Defines the block for this line chart instance. |
| background-color | background-color "ff0000" | Optional | Sets the background color for the chart. Uses a hexadecimal code to identify colors. |
| cplan | cplan "/cplans/basic_101.cplan" | Optional |
Indicates the data source. Can include filters. If a cPlan is not defined, the chart uses the cPlan that is used by the page that calls the chart. |
| dimension | dimension "Posting Period" | Required | Names the dimension to display in the chart. Line charts can only have one dimension. |
| first | first 10 | Optional |
Identifies how many summary values appear in the chart. If this tag is omitted, the entire data set is displayed. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
| hide-legend | hide-legend | Optional | Indicates that the legend does not appear on the chart. |
| id |
line-chart id = "line" { ... } |
Optional | Provides a means to refer to this line-chart block. |
| legend-location |
legend-location "top" legend-location "bottom" legend-location "left" legend-location "right" |
Optional |
Identifies the location of the legend: top, bottom, left, or right. By default, the legend is on the right side of the chart. |
| line | line column = "Cases" | Required |
Names the summary column to display in the chart. A line chart can have one to many summary columns. NOTE: Unlike tabular pages, chart columns do not change color when links are in use. |
| no-sort | no-sort | Optional | Specifies that the column information is not sorted. |
| percent | percent = 30 | Optional | Identifies the percentage of the display layout allocated for the element. The percent is relative, meaning if the page area is already subdivided, the element gets a percentage of that subdivided space. |
| sort-column |
sort-column "Cases" sort-column "Cases" reverse = true |
Optional |
Specifies a column to sort on. Using reverse = true sorts in the opposite direction. Use the first tag with sort-column to display a limited number of the highest or lowest values. |
| title | title "Line Chart" | Optional | Indicates a title for the resulting chart. |
| title-justification |
title-justification "left" title-justification "right" title-justification "center" |
Optional |
Aligns the title of the chart to the left, right, or center. By default, the chart title is justified to the center of the title bar. |
Pie Chart Tags
|
Tag |
Examples |
Status |
Notes |
|---|---|---|---|
| pie-chart |
pie-chart { ... } |
Required | Defines the block for this pie chart instance. |
| background-color | background-color "ff0000" | Optional | Sets the background color for the chart. Uses a hexadecimal code to identify colors. |
| column | column column = "Cases" | Required |
Names the summary column to display in the chart. A pie chart can have only one summary column. NOTE: Unlike tabular pages, chart columns do not change color when links are in use. |
| cplan | cplan "/cplans/basic_101.cplan" | Optional |
Indicates the data source. Can include filters. If a cPlan is not defined, the chart uses the cPlan that is used by the page that calls the chart. |
| dimension | dimension "Posting Period" | Required | Names the dimension to display in the chart. Charts can only have one dimension. |
| hide-legend | hide-legend | Optional | Indicates that the legend does not appear on the chart. |
| id |
pie-chart id = "pie" { ... } |
Optional | Provides a means to refer to this pie-chart block. |
| legend-location |
legend-location "top" legend-location "bottom" legend-location "left" legend-location "right" |
Optional |
Identifies the location of the legend: top, bottom, left, or right. By default, the legend is on the right side of the chart. |
| percent | percent = 30 | Optional | Identifies the percentage of the display layout allocated for the element. The percent is relative, meaning if the page area is already subdivided, the element gets a percentage of that subdivided space. |
| title | title "Pie Chart" | Optional | Indicates a title for the resulting chart. |
| title-justification |
title-justification "left" title-justification "right" title-justification "center" |
Optional |
Aligns the title of the chart to the left, right, or center. By default, the chart title is justified to the center of the title bar. |
See also: