All the report items in ActiveReportsJS share common properties that have one of the following types.
These are the most basic property types:
Boolean. After you set the value of a scalar property at design time, it can't change at runtime.
The Properties panel provides the text input for editing
String values, the toggle switch for setting
Boolean values, and the numeric up-down for setting
Enum properties require you to choose a value from the pre-defined list. For example, the
Page Orientation property of a report may be
Landscape. The editor of these properties is the drop-down list.
Length properties usually represent the size of some aspect of a report item, for instance, its dimensions. A
Length value is a string consisting of two parts.
Valueis a decimal number
Unitis one of the following units of measure
0.25pt. The editor of these properties is the text editor.
expression is a formula that composed using the expression language. The result of a formula is one of
Length types mentioned above. For example, when we say that a property is a
string expression, this property's value should be an expression that evaluates to a string.
Static expressions do not change their value at runtime.
Dynamic expressions can not be evaluated at design time and are used to set up conditional formatting or dynamic visibility.
The recommended way to modify expressions is to use the Expression Editor that can be invoked using the drop-down menu that appears if you click the box on the right boundary of a property editor.
The same drop-down menu allows you to reset the property to its default value.
Collection is a list containing one or more items of the same type. Items can, in turn, consist of several properties of different types. The Properties panel has the
Add Item and
Show Items buttons on the right boundary of a
Collection property. The former adds a default item into the collection. The latter expands the list of items and allows to delete or edit them.
All the report items have the following set of properties.
Nameis the String that identifies a report item and is displayed in the Report Explorer
Leftin Length units determine the location of a report item relative to its parent container, such as a report body or Banded List section.
Heightin Length units set a report item's size.
Tooltipis the string expression that sets the text displayed when a report reader hovers over a report item at preview time.
Bookmarkis the string expression that allows a report item to be the target of the Jump To Bookmark interactivity action.
Labelis the string expression that determine the text associated with a report item that appears in the Report Map and Table of Contents.
ZIndexis the number that specifices the report item's stack order in the output.
Directionexpression that should evaluate to one of the following values specifies the default direction of a textual content within a report item.
LTR- text direction goes from left-to-right
RTL- text direction goes from right-to-left
Languagestring expression determines the default language to use for dates and number formatting within a report item.
Writing Modeexpression that should evaluate to one of the following values sets whether the textual content within a report item is laid out horizontally or vertically as well as the direction in which text moves.
lr-tb- if the
LTR, textual content flows horizontally from left to right. For
RTLdirection, content moves horizontally from right to left. The following horizontal line resides below the previous line.
tb-rl- if the
LTR, textual content flows vertically from top to bottom, and the following vertical line resides to the left of the previous line. For
RTLdirection, content flows vertically from bottom to top, and the following vertical line resides to the right of the previous line.
Background Coloris an expression that should evaluate either to a cross-browser color name or to a hexadecimal color code, such as
#face0d. You can choose a color using the drop-down menu of the
Background Colorproperty at design time.
Background Imageallows setting an image to be used as the background. The drop-down editor provides a quick way to choose the image.
Sharedtab enumerates image files that reside in the same folder as the report template
Embeddedtab contains the list of embedded images
Databasetab shows the fields from the report datasets
expandicon on the right side of the
Sourcespecifies where the image come from
External- URL or a file on the local file system.
Embedded- embedded report images.
Database- a data set field that contains the image data in
Valueexpression is an image Id, for instance the
MIME Typeexpression specifies the image type. Supported types are
Repeatenum property sets the arrangement of the background image if its size is less than the one of a report item.
Repeat- to repeat vertically and horizontally to fill the available size
NoRepeat- to display the image only once
RepeatX- to repeat horizontally to fill the available width
RepeatY- to repeat vertically to fill the available height
Bordersection includes several properties that allow you to set the appearance of a report item's border
Widthexpression in Length units sets the default border width.
Styleexpression that should evaluate to one of
Insetvalues sets the default border style.
Colorexpression that should evaluate either to a cross-browser color name or to a hexadecimal color code sets the default border color.
Colorapply to the left, top, right, and bottom boundaries of a report item. You can set the individual border properties for these sides by expanding corresponding editors using the icon on their right side.
Paddingexpression in Length units sets space around a report item's content. The default value applies to the left, top, right, and bottom boundaries of a report item. You can set the individual padding values for these sides by expanding the
Paddingeditor using the icon on its right side.
These group of properties is available for various elements of a Chart report item.
Widthexpression in Length units sets the line thickness.
Styleexpression that should evaluate to one of
Insetvalues sets the line style.
Colorexpression that should evaluate either to a cross-browser color name or to a hexadecimal color code sets the line color.
None- no page breaks are added
Start- to add a page break before a report item
End- to add a page break after a report item
StartAndEnd- to add a page break before and after a report item
All the report items determine their visibility at runtime using the following properties.
Hiddenboolean expression sets the report item's initial visibility. If the
True, then a report item is not displayed. By default, the
Falseand a report item is displayed.
ToggleItemis the name of a textbox that controls the visibility of a report item. If this property is set, then the specified
collapseicon on its left boundary. If a report reader clicks this icon, a report re-renders, and a report item shows or hides. This property can be used to create Drill-Down reports.
Some report items or their parts display textual content whose appearance is determined by the following properties.
Colorexpression that should evaluate either to a cross-browser color name or to a hexadecimal color code sets the text color.
Font Familystring expression specifies the font to use for text.
Font Styleexpression that should evaluate to
Italicspecifies the font style to use for text.
Font Weightexpression that should evaluate to one of the
Boldervalues sets how thick or thin characters in text should be displayed.
Font Sizeexpression in Length units specifies the size of a font.
Text Decorationexpression should evaluate one of the
LineThroughvalues and specifies the decoration added to the text.
Text Alignexpression that should evaluate to one of the following values sets the alignment of text
General- aligns numbers and dates to the right and everything else to the left
Left- aligns the text to the left
Right- aligns the text to the right
Center- centers the text
Justify- stretches the multiline text so that each line has equal width
Text Justifyexpression affects if
Justifyand should evaluate to one of the following values
Auto- changes the space between words, except for the last line.
Distribute- the same as
DistributeAllLines- changes the space between words for all lines.
Vertical Alignthat should evaluate to one of the
Bottomvalues sets the vertical alignment of text within its bounding box.
Wrap Modeexpression that should evaluate to one of the following values specifies how words should break when reaching the end of a line
NoWrap- line breaks do not occur
CharWrap- line breaks occur at any character
WordWrap- line breaks occur at the end of words
Line Spacingin Length units sets a text line's height. It is converted to the line height CSS style.
Character Spacingin Length units sets the space between characters in a text.