Common Block Properties

The blocks that make up a dashboard are described with a set of properties specified using the <prop> element.

Some properties are common for a number of blocks, such as block formatting, attributes of the title, background, or fill, and so on, others are unique for a respective block type, for example, URL address for the HTML block, flag of image stretching or compression for the Table block, and so on.

See below description of common properties for dashboard blocks.

NOTE. These properties are not mandatory for all block types. A specific list of properties for each block type is given in the respective section.

Common properties:

Property	Data type	Description
name	String	Block name.
expandable	0\|1	It determines whether the block can be expanded to fit the screen.

Data source description:

Property	Data type	Description
dataSource	Structural property
objectKey	Key	Repository object key.

Block title:

Property	Data type	Description
blockTitle	Structural property
show	0\|1	It determines whether to show title.
text	String	Title text.
font	Structural property	Font.
color	Color	Font color.
family	Font	Font family.
isBold	0\|1	It determines whether the title is bold.
isItalic	0\|1	It determines whether the title is italic.
isUnderline	0\|1	It determines whether the title is underlined.
size	Size	Font size.

Block fill:

Property	Data type	Description
background	Structural property
useBackground	0\|1	It determines whether to use a fill for block background.
backgroundColor	Color	Fill color. If a gradient fill is used, this property determines the first color of the gradient.
useGradient	0\|1	It determines whether gradient block fill is used.
gradientColor	Color	Second color of the gradient.
gradientAngle	Number	Gradient angle. The property can have only integer values that range between: [-360; 360].

Block formatting:

Property	Data type	Description
decor	Structural property
useBorderRadius	0\|1	It determines whether block corners are rounded.
cornerRadius	Number	The rounding radius of the block corners.
useBorder	0\|1	It determines whether block borders are shown.
borderColor	Color	Block border color.
borderWidth	Size	Block border width.
useShadow	0\|1	It determines whether block shadow is displayed.
shadowColor	Color	Block shadow color.
shadowWidth	Size	Block shadow width.
shadowOpacity	Percentage	Block shadow opacity degree. The lower is the value, the more transparent is the shadow.
paddings	Structural property	Parameters of block paddings.
usePaddings	0\|1	Determines whether paddings are used in the block.
left	Size	Left padding.
right	Size	Right padding.
top	Size	Top padding.
bottom	Size	Bottom padding.

Block position in the container:

Property	Data type	Description
layout	Structural property
left	Size	Distance between the block and left border of the external container.
top	Size	Distance between the block and top border of the external container.
right	Size	Distance between the block and right border of the external container.
bottom	Size	Distance between the block and bottom border of the external container.
width	Size	Block width.
height	Size	Block height.
anchorTop	0\|1	It determines whether to fix the distance between top border of the external container and the block.
anchorBottom	0\|1	It determines whether to fix the distance between the bottom border of the external container and the block.
anchorLeft	0\|1	It determines whether to fix the distance between the left border of the external container and the block.
anchorRight	0\|1	It determines whether to fix the distance between the right border of the external container and the block.

When determining block position in the container, the user must specify at least two of the three sizes for each dimension. For example, top + height or top + bottom for the vertical dimension; left + width or left + right for the horizontal dimension.

Object grouping:

Property	Data type	Description
groupId	Identifier	Identifier of the group that contains the object.
groups	Structural property	It determines whether groups are present in the dashboard.
key	Identifier	Object group identifier.
tag	Row	Group property name. Group property is group identifier.
val	Row	Group property value. Group property value is unique for each group located in the dashboard.

Setting up working with metrics bus:

Property	Data type	Description
selectionBus	Structural property
handle	0\|1	It determines whether the subscription for changing the block selection is used.
useRangeSel	0\|1	It determines whether the block selection affects building of the controlled block.
params	A collection of the same type properties	A list of controlling blocks.
handleBlockKey	Identifier	The code of the controlling block located in the report.
handleDics	A collection of the same type properties	A list of controlling dimensions.
dicKey	Key	The dictionary key used to build the dimension.

A selection bus is used in the blocks that are bound to a data source and work with selection of elements in source dimensions.