Overview Page Tags
You can customize the layout of a DiveTab overview page, so there are many different tags that you can use. There are basic tags that must be defined, additional tags that are typically defined, and some advanced tags that can be defined to provide enhanced capabilities.
An overview page is defined using an overview-page tag with additional tags between an open { and close } brace. An overview page is often the first page defined in a sections block and can also be defined in a pages block.
Tag |
Examples |
Status |
Notes |
---|---|---|---|
overview-page |
overview-page { ... } |
Required |
Defines the block for this overview page instance. |
cplan |
cplan "/cplans/sales.cplan" cplan "/cplans/sales.cplan" { filter `value("Salesperson") = "George"` } |
Required |
Indicates the data source. Can include a filter with an expression, and parameters. |
elements |
elements { <element> <element> } |
Optional |
Lists individual elements or uses the elements block. |
<element> |
Multiple tags to define vertical and horizontal spacing, layout, charts, grids, boxes, links, tables, and images. |
Optional |
Determines the format and layout for overview and central pages. |
id |
overview-page id = "Supplier" |
Optional |
Gives the page an identifier. Required to reference the page elsewhere in the script. |
layout |
layout orientation = "portrait" { <element> <element> } |
Optional |
Sets up the portrait or landscape layout of the screen and starts the presentation details for the page. The default orientation is landscape. |
percent |
percent = 50 percent = 85 |
Optional |
Identifies the percentage of the display layout allocated for the element. NOTE: The total percentage of display layout elements within a vsplit or an hsplit must equal 100. |
quickview-set |
quickview-set { cplan "/cplans/demo.cplan" dimension-quickview "Sales Region" dimension-quickview "Product Family" } quickview-set { cplan "/cplans/data.cplan" dimension-quickview "Dimension A" { default-values "Some Value" } dimension-quickview "Dimension B" all-values = false { default-values "2016/10/19" } dimension-quickview "Dimension C" { default-values "Multiple" "Values" } } |
Optional |
Names dimensions for QuickViews. Can include default values. |
screen |
screen { ... } |
Optional |
Starts the configuration for a screen. Multiple screen blocks can be defined in each tab block. |
tab |
tab "Overall Sales" { ... } tab "NY Sales" filtered = true { ... } |
Optional |
Specifies a name for the tab and opens the code block to define the data for a screen. The name displays for the user when multiple tabs are specified for one page. Each tab block can also contain one or more screen blocks. |
title |
title = "Supplier Info Page" |
Required |
Appears in the title bar when the page displays. Displays in the Sections menu when defined in a sections block. |
See also: