QuickView Set Tags

A Spectre QuickView Set script is defined using a quickview-set tag with optional tags between open and close { } braces. This topic describes the tags that can be used within the quickview-set code block. The tags are listed in alphabetical order, after the quickview-set tag, in the following table.

QuickView Set Tags

Tags Examples Notes
quickview-set

quickview-set {

cplan "/cbases/sales.cplan"

dimension-quickview "Region"

}

 Defines the block for the Spectre QuickView Set definition.
alias

dimension-quickview "Direction" label="NSEW" {

alias "dir"

}

 Specifies an alias name for the named QuickView.
all-values dimension-quickview "Date" all-values=false

Indicates that All Values should not be an option for the end-user. Spectre's default value for all-values changes based on single-selection. If single-selection=false or it is not set, the default for all-values is true. If single-selection=true, the default for all-values is false.
column

sort {

column "Order Date" reverse=true

}

 Specifies the dimension used in the QuickView for a sort block.
cplan

cplan "/common/basic.cplan"

cplan {

text-input "data.txt"

}

Points to the cPlan in the project.

Can also refer to a text file.
default-first-value default-first-value offset=1

Sets the default value to be the first value in the QuickView plus the offset. The selection is based on the post-sort population of the QuickView values. The main use case is for defaulting to the first value even when All Values is an allowed selection. It is also useful with a year QuickView that is reverse-sorted so the most relevant years are on top.

The default-first-value can be used without the offset.

NOTE: The offset cannot be negative and should be smaller than the size of the QuickView.
default-last-value default-last-value offset=1

Sets the default value to be the last value in the QuickView minus the offset. The selection is based on the post-sort population of the QuickView values. Indicating the last value is useful in a date QuickView where the data in the current date may be incomplete.

The default-last-value can be used without the offset.

NOTE: The offset cannot be negative and should be smaller than the size of the QuickView.
default-range

dimension-quickview "Date Range" {

default-range "2017/03/01" "2022/04/01"

}

 Sets the values for the default selection to be each date in the provided date range.
default-values

dimension-quickview "Direction" {

default-values "East" "West"

}

 Sets the values for the default selection.
dependency

quickview-set dependency="circular" {

cplan "/common/basic.cplan"

dimension-quickview "Color"

dimension-quickview "Mood"

dimension-quickview "Taste"

}

Indicates dependencies for individual QuickViews in the set. The default is sequential.

  • A circular dependency means all QuickViews are updated when one is—they all depend on each other.
  • A sequential dependency means that a QuickView is updated only if it is downstream in the hierarchy defined in the qvset script—the higher value dictates what is available in the lower QuickViews.

NOTE: To create independent QuickViews for use on a DivePort page, use separate QuickView Sets and separate QuickView portlets. DivePort will run the QuickView Sets separately, so there is no dependency between them.
dimension-quickview dimension-quickview "Color" Defines a QuickView for the named dimension found in a cPlan.
dimension

dimension-quickview "Y-moods" {

dimension "mood" {

group "ends with y" `rsubstr(value("mood"),1,1)="y"`

}

}

Names the dimension that will have a named group defined. Note the group in this example is the result of an expression using that dimension.

NOTE: The group expression can only refer to the dimension column itself, not to other columns in the cBase.
group

quickview-set {

cplan "/common/basic.cplan" {

dimension "Direction" {

group "Northeast" "North" "East"

}

}

dimension-quickview "Color"

dimension-quickview "Direction" {

default-values "Northeast"

}

}

Defines a group for the cPlan that can be used in a dimension QuickView. The group can be defined using specific values or by using an expression. As a sub-component of the dimension definition, the group expression must use the dimension column itself, not other columns in the cBase.

NOTE: Named groups defined in a cPlan can be referred to by a qvset. This approach allows the dive and mrk files to reference the cPlan directly to use the named groups. Named groups are brought in automatically from the cPlan, so there is no extra syntax needed in the qvset file.
include-unknown include-unknown=false Indicates if the unknown value is in the values list.
include-null default-values "North" "South" include-null=false Indicates if a null value is in the default values list. A null value appears as <Blank Value>.
keep

dimension-quickview "COL" {

keep {

value "B"

value "D"

}

}

Limits dimension population only to listed values.

NOTE: Period values may be provided only if the column is specifically typed as a period.
label dimension-quickview "Date" label="Anchor" all-values=false Specifies an alternative label for the dimension QuickView.
list-quickview

list-quickview "Percentile" {

values "All" "5" "10" "20" "50"

}

 Names and defines a List style QuickView and its values.
offset offset=2 Applies an offset to default-last-value or last-value tags.
remove

dimension-quickview "COL" {

remove {

value "B"

value "D"

}

}

Removes the listed value from the dimension population.

NOTE: Period values may be provided only if the column is specifically typed as a period.
single-selection single-selection=true

Indicates that only one value can be selected from a QuickView. When such a qvset file is used by a client, the end-user is only allowed to select one value. Adding single-selection=true to a QuickView that does not have an all-values tag will by default set all-values to false.
sort

dimension-quickview "Order Date" {

sort {

column "Order Date" reverse=true

}

}

 Indicates sorting for a dimension quickview. You can only specify one column.
take-parameter

take-parameter "Date" default="2018/06/30"

 Accepts the parameter value from the calling Dive script.
values

list-quickview "Color" all-values=true {

values "Red" "Green" "Blue"

}

 Specifies the QuickView values in line for a list-quickview.

See also: