## Modelica_LinearSystems2.Utilities.Plot.Records

Records used to define the function interfaces

### Package Content

Name | Description
--- | ---
Diagram | Properties of a diagram in a figure containing one or more curves
Curve | Properties of a curve (displayed in a diagram)
Device | Properties of a device
DefaultDiagram | Diagram with no curves (might be used as default diagram)

## Modelica_LinearSystems2.Utilities.Plot.Records.Diagram

Properties of a diagram in a figure containing one or more curves

### Information

Extends from Modelica.Icons.Record (Icon for a record).

### Parameters

Type | Name | Default | Description
--- | --- | --- | ---
Curve | curve[:] |  | Properties of the curves in one diagram of the figure
String | heading | "" | Heading displayed above diagram
Real | heightRatio | 0.45 | Height of diagram = heightRatio*diagramWidth
Boolean | grid | true | = true, if grid is shown
Axes
String | xLabel | "" | String displayed at horizontal axis
String | yLabel | "" | String displayed at vertical axis
Boolean | logX | false | = true, if logarithmic scale of x-axis
Boolean | logY | false | = true, if logarithmic scale of y-axis
Boolean | uniformScaling | false | = true, if same vertical and horizontal axis increment
Legend
Boolean | legend | true | = true, if legend is shown
Boolean | legendFrame | false | = true, if frame around legend
Boolean | legendHorizontal | true | = true, if horizontal legend (provided it is meaningful)
LegendLocation | legendLocation | Modelica_LinearSystems2.Util... | Legend placement

### Modelica definition

    record Diagram
      "Properties of a diagram in a figure containing one or more curves"
      extends Modelica.Icons.Record;

      Modelica_LinearSystems2.Utilities.Plot.Records.Curve curve[:]
        "Properties of the curves in one diagram of the figure";

      String heading="" "Heading displayed above diagram";
      Real heightRatio = 0.45 "Height of diagram = heightRatio*diagramWidth";
      Boolean grid=true "= true, if grid is shown";

      /* group "Axes" (Axes properties) */
      String xLabel="" "String displayed at horizontal axis";
      String yLabel="" "String displayed at vertical axis";
      Boolean logX = false "= true, if logarithmic scale of x-axis";
      Boolean logY = false "= true, if logarithmic scale of y-axis";
      Boolean uniformScaling = false
        "= true, if same vertical and horizontal axis increment";

      /* group "Legend" (Legend properties) */
      Boolean legend = true "= true, if legend is shown";
      Boolean legendFrame=false "= true, if frame around legend";
      Boolean legendHorizontal=true
        "= true, if horizontal legend (provided it is meaningful)";
      Modelica_LinearSystems2.Utilities.Plot.Types.LegendLocation legendLocation=
                       Modelica_LinearSystems2.Utilities.Plot.Types.LegendLocation.Above
        "Legend placement";

    end Diagram;

## Modelica_LinearSystems2.Utilities.Plot.Records.Curve

Properties of a curve (displayed in a diagram)

### Information

Extends from Modelica.Icons.Record (Icon for a record).

### Parameters

Type | Name | Default | Description
--- | --- | --- | ---
Real | x[:] |  | x-values of curve
Real | y[:] |  | y-values of curve
String | legend | "" | Legend text of curve
Boolean | autoLine | true | = true, if automatic line properties of curve
If autoLine = false (otherwise ignored)
Integer | lineColor[3] | {0,0,255} | Color of curve as rgb values
LinePattern | linePattern | Modelica_LinearSystems2.Util... | Line pattern of curve
PointSymbol | lineSymbol | Modelica_LinearSystems2.Util... | Symbol for points on curve

### Modelica definition

    record Curve "Properties of a curve (displayed in a diagram)"
      extends Modelica.Icons.Record;

       Real x[:] "x-values of curve";
       Real y[:] "y-values of curve";
       String legend="" "Legend text of curve";

       Boolean autoLine = true "= true, if automatic line properties of curve";

       Integer lineColor[3]={0,0,255} "Color of curve as rgb values";

       Modelica_LinearSystems2.Utilities.Plot.Types.LinePattern linePattern=
          Modelica_LinearSystems2.Utilities.Plot.Types.LinePattern.Solid
        "Line pattern of curve";
       Modelica_LinearSystems2.Utilities.Plot.Types.PointSymbol lineSymbol=
          Modelica_LinearSystems2.Utilities.Plot.Types.PointSymbol.None
        "Symbol for points on curve";

    /*
       Modelica_LinearSystems2.Utilities.Plot.Types.LineThickness_mm lineThickness=0.25
        "Line thickness of curve" annotation(Dialog(group="If autoLine = false (otherwise ignored)"));
       Modelica_LinearSystems2.Utilities.Plot.Types.LineThickness_mm lineSymbolSize=3
        "Symbol size" annotation(Dialog(group="If autoLine = false (otherwise ignored)"));
    */

    end Curve;

## Modelica_LinearSystems2.Utilities.Plot.Records.Device

Properties of a device

### Information

Extends from Modelica.Icons.Record (Icon for a record).

### Parameters

Type | Name | Default | Description
--- | --- | --- | ---
DrawingUnit_mm | xTopLeft | 0 | Horizontal position of top left figure corner if applicable (e.g. window) [mm]
DrawingUnit_mm | yTopLeft | 0 | Vertical position of top left figure corner if applicable (e.g. window) [mm]
DrawingUnit_mm | diagramWidth | 140 | Width of diagram [mm]
ImageResolution_dpi | windowResolution | 96 | [dpi] Image resolution in window if applicable (e.g. unscaled window)
Boolean | autoLineColor | true | if automatic line properties: distinguish curves by color otherwise by line style

### Modelica definition

    record Device "Properties of a device"
      extends Modelica.Icons.Record;

      Modelica_LinearSystems2.Utilities.Plot.Types.DrawingUnit_mm xTopLeft=0
        "Horizontal position of top left figure corner if applicable (e.g. window)";
      Modelica_LinearSystems2.Utilities.Plot.Types.DrawingUnit_mm yTopLeft=0
        "Vertical position of top left figure corner if applicable (e.g. window)";
      Modelica_LinearSystems2.Utilities.Plot.Types.DrawingUnit_mm diagramWidth=140
        "Width of diagram";
      Modelica_LinearSystems2.Utilities.Plot.Types.ImageResolution_dpi
        windowResolution=96
        "[dpi] Image resolution in window if applicable (e.g. unscaled window)";

      Boolean autoLineColor = true
        "if automatic line properties: distinguish curves by color otherwise by line style";
    end Device;

## Modelica_LinearSystems2.Utilities.Plot.Records.DefaultDiagram

Diagram with no curves (might be used as default diagram)

### Information

Extends from Diagram (Properties of a diagram in a figure containing one or more curves).

### Parameters

Type | Name | Default | Description
--- | --- | --- | ---
Curve | curve[:] | fill(Curve(x=fill(0.0, 0), y... | Properties of the curves in one diagram of the figure
String | heading | "" | Heading displayed above diagram
Real | heightRatio | 0.45 | Height of diagram = heightRatio*diagramWidth
Boolean | grid | true | = true, if grid is shown
Axes
String | xLabel | "" | String displayed at horizontal axis
String | yLabel | "" | String displayed at vertical axis
Boolean | logX | false | = true, if logarithmic scale of x-axis
Boolean | logY | false | = true, if logarithmic scale of y-axis
Boolean | uniformScaling | false | = true, if same vertical and horizontal axis increment
Legend
Boolean | legend | true | = true, if legend is shown
Boolean | legendFrame | false | = true, if frame around legend
Boolean | legendHorizontal | true | = true, if horizontal legend (provided it is meaningful)
LegendLocation | legendLocation | Modelica_LinearSystems2.Util... | Legend placement

### Modelica definition

    record DefaultDiagram
      "Diagram with no curves (might be used as default diagram)"
      extends Diagram(curve=fill(Curve(
                                 x=fill(0.0,0),y=fill(0.0,0)),0));
    end DefaultDiagram;