Link Tags

Links are used in any page type. Links can be defined in a chart, grid, or table element in free-form layout pages or in tabular layout pages.

Tag

Examples

Status

Notes

alert

alert "Alert" {

value column = "Cases"

low-threshold 1000

high-threshold 100000

}

Optional

Defines an alert based on the named column and thresholds.

background-color background-color "123abc" Optional Sets the background color of the grid. Color is written as a hexadecimal code.
border border Optional Applies a border to the grid block area.
bullet

bullet column = "Cases" {

title "Bullet"

bar-color "123abc"

}

Optional

Defines a bullet based on the named column.

column-set

column-set id = "cs-grid" {

text column = "Cases"

text column = "Cost"

text column = "Net Sale"

}

Optional

Defines a column-set block. These are previously defined sets of columns in a definitions block.

Within a grid block, a column-set cannot include an expand-set.

cplan cplan "/cplans/training/test.cplan" Optional

Indicates the data source. Can include filters.

If a cPlan is not defined, the grid uses the cPlan that is defined for the containing block.

grid

grid {

row "Cases"

row "Cost"

}

 

grid id = "grd-dimensions" {

row {

text column = "Cases Count"

}

row {

text column = "Cost Count"

}

}

Required Defines a grid block by specifying rows from a cPlan and the strings for those rows.
location latlong-column location latlong-column = "calc-latlong" Optional Identifies the placement of and distance to a location using latitude and longitude. Works in conjunction with the location-distance tag.
location-distance

location-distance {

link {

map column = "Lat-Long"

}

}

Optional Identifies the placement of and distance to a location using latitude and longitude. Works in conjunction with the location latlong-column tag.
map column map column = "Lat-Long" Optional Identifies the summary column that contains location information for a map. This can be used by itself or with the location-distance tag if you want to calculate distance.
page

link {

page id = "rp-brands"

}

Optional

Identifies the data page that you want to explicitly link to. The id tag specifies the page to use.

parameter

link {

page area-id = "data-area-landing" id = "central-pg"

parameter = "Customer" "1770 HOUSE"

}

Optional

Identifies the dimension and the dimension value to pass on to the target page. The target page is identified by the page id.

percent

percent = 50

percent = 85

Optional

Identifies the percentage of the display layout allocated for the element.

NOTE: The total percentage must equal 100.

row

row "Cost"

 

row {

text column = "Cost Count"

}

Required

Defines a row for a grid block. A row can only contain one summary value.

Within an hsplit tag, the rows show left to right; within a vsplit tag, they still show left to right.

Can include an alert, bullet, column-set, or text-column.

text column

row {

text column = "Cases" {

justification "left"

link {

page id = "rp-grid"

}

}

}

Optional

Identifies which summary column the row is referring to.

When used in a grid block, the content can be justified, or include a link, or both.

See also: