Skip to content

rephrase.Series (+rephrase)

Create a Series object for rephrase reports

Syntax

output = rephrase.Series(title, input, varargin)

Input arguments

title [ string ]

Legend text for the series.

input [ Series ]

Series type of object which contains the data to be displayed

Output arguments

output [ Series ]

Series type object with the assigned arguements to be passed into the rephrase objects.

Options

Units= [ string ]

Description

Bands= [ Bands ]

Bands type object to be displayed. See +rephrase/Bands for more information.

ShowLegend=true [ true* | false ]

Flag which enables the graph legend by default and can be set to false.

LineWidth=2 [ numeric ]

The option sets the linewidth.

Type='scatter' [ string 'scatter*' | 'Bar' ]

The option sets the type of the graph to be displayed. It is set by default as 'scatter' but can be change to 'Bar'.

Markers= [ struct ]

The option sets the markers to be displayed.

StackGroup= [ string ]

The option sets the stack groups for type 'Bar'.

Fill='none' [ string ]

Description

Text= [ string ]

Description

Color= [ string ]

The option sets the color by using the RGB hex code of the displayed Series.

FillColor= [ string ]

The option sets the fill color by using the RGB hex code of the displayed Series.

Possible children

None

Description

The function +rephrase/Series returns the Series object based on the input arguments and options set by the user. The object itself needs to be passed to the parent rephrase object such as +rephrase/SeriesChart.

The object requires the child to be defined either via a standalone object or a class function fromMultivariate. See the example below.

Examples

    % Using standalone Series object
    chart1 = rephrase.SeriesChart("Chart 1", startDate:endDate) ...
        + rephrase.Series("Series X", d.x);

    % Using fromMultivariate class function
    roundNames = ["Series X1", "Series X2"]
    chart1 = rephrase.SeriesChart("Chart 1", startDate:endDate) ...
        + rephrase.fromMultivariate([roundNames(1),roundNames(2)], d.x);