Struct Report 

pub struct Report {

    pub name: String,
    pub page: PageSettings,
    pub culture: String,
    pub data_sources: Vec<DataSource>,
    pub data_source: Option<String>,
    pub data_member: Option<String>,
    pub filter: Option<String>,
    pub sort: Vec<SortField>,
    pub parameters: Vec<Parameter>,
    pub calculated_fields: Vec<CalculatedField>,
    pub styles: BTreeMap<String, Style>,
    pub report_header: Option<Band>,
    pub page_header: Option<Band>,
    pub groups: Vec<Group>,
    pub detail: Band,
    pub detail_reports: Vec<DetailReport>,
    pub report_footer: Option<Band>,
    pub page_footer: Option<Band>,
}

A banded report definition.

use ravenrs_report::{Band, Control, Report};

let report = Report::new("Customers")
    .page_header(Band::new(24.0).control(Control::label("Name").at(0.0, 0.0, 200.0, 20.0)))
    .detail(Band::new(20.0).control(Control::field("[Name]").at(0.0, 0.0, 200.0, 20.0)));
let json = report.to_json();
assert_eq!(ravenrs_report::Report::from_json(&json).expect("round trip"), report);

Fields

name: String

The report’s name, also the document title.

page: PageSettings

Paper size and margins.

culture: String

Culture for numbers and dates, such as pt-BR or en-US.

data_sources: Vec<DataSource>

Where the data comes from, saved with the layout. The engine renders whatever data it is given; designers and the report server load it from here.

data_source: Option<String>

The data source that feeds the report (the first one when unset).

data_member: Option<String>

Path to the rows in the data (orders, report.lines). Without it, an array of data is the rows and an object is a single row.

filter: Option<String>

Rows for which this expression is false are left out.

sort: Vec<SortField>

Sorting of detail rows within their groups.

parameters: Vec<Parameter>

Values the user supplies when running the report (?Name in expressions).

calculated_fields: Vec<CalculatedField>

Fields computed from other fields, usable like data fields.

styles: BTreeMap<String, Style>

Named styles that controls refer to.

report_header: Option<Band>

Printed once, at the top of the first page.

page_header: Option<Band>

Printed at the top of every page.

groups: Vec<Group>

Groups, outermost first.

detail: Band

Printed once per row.

detail_reports: Vec<DetailReport>

Nested reports printed after each row’s detail (master-detail).

report_footer: Option<Band>

Printed once, after the last row.

page_footer: Option<Band>

Printed at the bottom of every page.

Implementations

impl Report

pub fn new(name: impl Into<String>) -> Self

An empty report on A4 paper, in US English.

pub fn from_json(json: &str) -> Result<Self, Error>

Reads a report from JSON.

pub fn to_json(&self) -> String

The report as indented JSON.

pub fn page(self, page: PageSettings) -> Self

Sets the paper.

pub fn data_source(self, source: DataSource) -> Self

Adds a data source and makes it the report’s source.

pub fn embedded_data(&self) -> Option<&Value>

The data of the report’s source when it is stored in the layout.

pub fn culture(self, culture: &str) -> Self

Sets the culture (pt-BR, en-US).

pub fn data_member(self, path: &str) -> Self

Sets the path to the rows in the data.

pub fn filter(self, expression: &str) -> Self

Keeps only rows where expression is true.

pub fn sort_by(self, expression: &str, descending: bool) -> Self

Adds a sort key.

pub fn parameter(self, name: &str, kind: ParameterKind, default: Value) -> Self

Adds a parameter with a default value.

pub fn parameter_label(self, label: &str) -> Self

Sets what the user is asked for the parameter added last.

pub fn calculated(self, name: &str, expression: &str) -> Self

Adds a calculated field.

pub fn style(self, name: &str, style: Style) -> Self

Adds a named style.

pub fn report_header(self, band: Band) -> Self

Sets the report header.

pub fn page_header(self, band: Band) -> Self

Sets the page header.

pub fn group(self, group: Group) -> Self

Adds a group level (outermost first).

pub fn detail(self, band: Band) -> Self

Sets the detail band.

pub fn detail_report(self, detail: DetailReport) -> Self

Adds a master-detail report.

pub fn report_footer(self, band: Band) -> Self

Sets the report footer.

pub fn page_footer(self, band: Band) -> Self

Sets the page footer.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Report

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Report

fn default() -> Report

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Report

where Report: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Report

fn eq(&self, other: &Report) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Report

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Report