API overview
This reference is generated from the TypeScript sources of @ariana-reports/core. The React and Vue packages re-export all of it, so everything below can be imported from @ariana-reports/react or @ariana-reports/vue too.
The components have their own pages: the props of ReportViewer are in The viewer and those of ReportDesigner in The designer. Both packages also export useViewer / useDesigner for the controllers, and ReportPage.
Classes
Section titled “Classes”Interfaces
Section titled “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
Section titled “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
Section titled “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
Functions
Section titled “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