Skip to content
ariana-report
Search
Ctrl
K
Cancel
Demos
Playground
GitHub
Select theme
Dark
Light
Auto
Menu
Getting started
Introduction
Installation
Your first report
Your first designer
Vite, Next.js and Nuxt
Material UI and other design systems
Guides
Template format
Bands and data regions
Groups and master-detail
Expressions
Formatting values
Styles and conditions
HTML formatting in text
Running totals per page
PDF, Excel and print
Fonts and other scripts
The viewer
The designer
Theming
Languages and locales
Saving and loading templates
Security
Demos
Live demos
Examples gallery
API reference
API overview
classes
DesignerController
ExpressionError
PageList
TemplateValidationError
ViewerController
functions
alignRects()
allRegions()
bandColorVars()
bidiLevels()
buildPrintDocument()
cellValue()
checkExpression()
clampZoom()
cloneTemplate()
clusterEdges()
compareValues()
compileExpression()
compileText()
componentPreview()
convertTemplateUnit()
convertUnit()
createBand()
createComponent()
createDataRegion()
createFontMeasurer()
createStandardFontMeasurer()
createStaticBand()
createTemplate()
cssColor()
cssFontFamily()
currencyToWords()
datePatternToExcel()
decodeDataUri()
decodeEntities()
designScale()
designSections()
detectDirection()
detectImageType()
distributeRects()
downloadBytes()
evaluateExpression()
excelNumberFormat()
exportExcel()
exportPdf()
fieldExpression()
findBand()
findComponent()
findGroup()
findRegion()
findUiLocale()
fitImage()
fitZoom()
fontFamilies()
formatCurrency()
formatDate()
formatLabel()
formatNumber()
formatPercent()
formatValue()
fromPoints()
generateId()
generateReport()
getBuiltins()
hasRtlCharacters()
imageSize()
inferFields()
injectStyles()
intersects()
isBidiControl()
isIdentifier()
isSafeImageSrc()
loadStandardFont()
luminance()
marqueeTargets()
mergeLabels()
mergeStyles()
mirrorChar()
numberToWords()
optionLabel()
parseColor()
parseExpression()
parseHtmlText()
parseTemplate()
pointsToColumnWidth()
printDocument()
readPath()
rectFromPoints()
registerUiLocale()
renderDocument()
renderPage()
reorderSegments()
resizeRect()
resolveBaseDirection()
resolveBorder()
resolvePadding()
resolvePageSize()
resolveRuns()
resolveStyle()
resolveUiLocale()
runsText()
safeFileName()
sanitizeForStandardFont()
sanitizeSheetName()
scanPlaceholders()
snapEdges()
snapMove()
snapshotBands()
snapToGrid()
splitPlaceholders()
standardFamily()
standardFontName()
themeFromMui()
themeVars()
toArgb()
toDate()
toDisplayString()
toExcelDate()
toNumber()
toPoints()
toRows()
toVisualOrder()
uiLocales()
validateTemplate()
visualRuns()
walkBands()
wrapRuns()
wrapSelection()
wrapText()
zoomInStep()
zoomOutStep()
interfaces
ArianaTheme
Band
BandHit
BandVisit
BorderSpec
CompiledExpression
CompiledText
ComponentBase
ComponentPreview
ConditionalStyle
CurrencyFormat
CustomPageSize
DataRegion
DataSourceDefinition
DateFormat
DesignerControllerOptions
DesignerSettings
DesignerState
DesignSection
EvaluateOptions
ExcelExportOptions
FieldDefinition
FontRegistration
FontSpec
GenerateOptions
Group
Guide
ImageComponent
KeyInput
LayoutBand
LayoutDocument
LayoutImage
LayoutIssue
LayoutLine
LayoutPage
LayoutRectangle
LayoutText
LayoutTextRun
LineComponent
LoadedImage
Margins
MuiThemeLike
NumberFormat
NumberFormatOptions
Padding
PageListOptions
PageListState
PageSettings
ParameterDefinition
PdfExportOptions
PercentFormat
Rect
RectangleComponent
RenderOptions
ReportTemplate
ResolvedBorder
ResolvedPadding
ResolvedStyle
ResolvedUiLocale
RGBA
RunBase
Selection
SnapOptions
SortRule
StaticBand
StyleProps
TextComponent
TextEvaluateOptions
TextMeasurer
TextRun
UiLocale
ValidateOptions
ValidationIssue
ValidationResult
ViewerControllerOptions
ViewerState
VisualRun
type-aliases
Alignment
BandRole
BaseDirection
BodyItem
BorderLineStyle
BorderSide
Calendar
ComponentType
ExpressionChecker
ExpressionNode
ExpressionScope
FieldType
FontStyle
FontWeight
FormatType
GroupSortDirection
IconName
ImageFit
ImageLoader
ImageType
LabelKey
Labels
LayoutItem
LineOrientation
Orientation
PageBandSlot
PaperSize
ReportComponent
ResizeHandle
SectionLabels
SortDirection
StandardFontFamily
TextAlign
TextDecoration
TextDirection
TextPart
Unit
ValueFormat
VerticalAlign
ViewMode
ZoomMode
variables
ARIANA\_STYLES
BORDER\_LINE\_STYLES
BORDER\_SIDES
BUILTIN\_NAMES
CALENDARS
COMPONENT\_TYPES
CSS
DARK\_THEME
DEFAULT\_LABELS
DEFAULT\_LOCALE
DEFAULT\_MAX\_DEPTH
DEFAULT\_MAX\_PAGES
DEFAULT\_MAX\_STEPS
DEFAULT\_STYLE
defaultImageLoader
DIRECTIONAL\_ICONS
DROP\_TARGET\_CLASS
en
ERROR\_MARKER
EXPRESSION\_SNIPPETS
fa
FIELD\_TYPES
FIT\_PADDING
FONT\_STYLES
FONT\_WEIGHTS
FORMAT\_TYPES
GROUP\_SORT\_DIRECTIONS
HTML\_TAGS
ICONS
IMAGE\_FITS
LINE\_HEIGHT\_FACTOR
LINE\_ORIENTATIONS
MAX\_ARRAY\_LENGTH
MAX\_EXPRESSION\_LENGTH
MAX\_STRING\_LENGTH
MAX\_ZOOM
MIN\_ZOOM
ORIENTATIONS
PAGE\_LIST\_CLASS
PAGE\_SLOT\_CLASS
PAPER\_SIZE\_NAMES
PAPER\_SIZES\_MM
PDF\_MIME
PX\_PER\_PT
RESERVED\_SCOPE\_NAMES
RESIZE\_HANDLES
SCHEMA\_VERSION
SORT\_DIRECTIONS
STANDARD\_FONT\_FAMILIES
STYLE\_ELEMENT\_ID
STYLE\_KEYS
TEXT\_ALIGNS
TEXT\_DECORATIONS
TEXT\_DIRECTIONS
UNITS
VERSION
VERTICAL\_ALIGNS
XLSX\_MIME
ZOOM\_LEVELS
Project
Known limitations
Contributing
Demos
Playground
GitHub
Select theme
Dark
Light
Auto
LayoutPage
Properties
Section titled “Properties”
Property
Type
Description
bands
LayoutBand
[]
-
number
number
1-based page number.
