User:Jcreer/SMS:DMI Control Curve Elements: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(Created page with "=====Element ''<x_column>'', ''<y_column>''===== {|class="wikitable" |- |width="70"|'''Info''' |width="530"|Used to define the attributes in the column such as text (heading)....")
 
No edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
{{TOCright}}
==Elements==
=====Element ''<control_curve>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"| Displays an curve push button. When pushed the xy curve values can be updated and a curve is displayed.
|-
|'''Versions'''
|2
|-
|'''Attributes'''
| [[SMS:Dynamic Model Interface Schema#Element <max_rows>|max_rows]], [[SMS:Dynamic Model Interface Schema#Element <flags>|flags]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]]
|-
|'''Children'''
| [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]]
|-
|'''Used by'''
| [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]
|-
|'''Example'''
|This example creates a curve limited to 10 rows.
<item>
    <control_curve>
        <unique_name>myCurve1</unique_name>
        <max_rows>10</max_rows>
        <flags>XY_USEDATE</flags>
        <x_column>
          <text>Time</time>
        </x_column>
        <y_column>
  <text>Velocity</text> 
        </y_column>
    </control_curve>
  …
|}
=====Element ''<x_column>'', ''<y_column>''=====
=====Element ''<x_column>'', ''<y_column>''=====
{|class="wikitable"
{|class="wikitable"
Line 32: Line 71:
   …
   …
|}
|}
==Attributes==
=====Attributes ''<flags>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|Flags are optional, and are used to modify the behavior/appearance of the control_curve.  Only 1 flag is currently defined:  XY_USEDATE.  When this flag is set, the x column becomes a date/time calendar.
|-
|'''Values'''
| XY_USEDATE
|-
|'''Versions'''
| 2
|-
|'''Used by'''
|width="530"| control_curve
|}
=====Attributes ''<max_row_count>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|Used to set the maximum number of rows allowed in a table or curve.
|-
|'''Values'''
| integer
|-
|'''Versions'''
| 3
|-
|'''Used by'''
|width="530"| table, control_curve
|}
=====Attribute ''<unique_name>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
A unique name given to an widget, which determines how to reference the widget. This is needed if the widget is being used as a dependency (parent), or if the widget value is being exported.  When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name.  The name must contain at least 1 non-numeric letter.  The name must be unique.  Names are not case sensitive, hence “aaa” is the same as “AAA”.
|-
|'''Values'''
|string (unique)
|-
|'''Version'''
|1
|-
|'''Used by'''
|width="530"|card, text_box, combo_box, edit_box, table, all elements starting with “custom_control”, check_box, text_box, control_curve
|}
[[Category:Jcreer|DMI]]

Latest revision as of 16:15, 4 March 2019


Elements

Element <control_curve>
Info Displays an curve push button. When pushed the xy curve values can be updated and a curve is displayed.
Versions 2
Attributes max_rows, flags, unique_name
Children x_column, y_column
Used by item, row, column
Example This example creates a curve limited to 10 rows.
<item>
   <control_curve>
       <unique_name>myCurve1</unique_name>
       <max_rows>10</max_rows>
       <flags>XY_USEDATE</flags>
       <x_column>
          <text>Time
       </x_column>
       <y_column>
  	<text>Velocity</text>   
       </y_column>	
   </control_curve>
  …
Element <x_column>, <y_column>
Info Used to define the attributes in the column such as text (heading).
Versions 2
Attributes none
Children text
Used by control_curve
Example This example creates a curve button with the date/time flag.
<item>
    <control_curve>
        <unique_name>myCurve1</unique_name>
        <flags>XY_USEDATE</flags>
        <x_column>
           <text>Time
        </x_column>
        <y_column>
           <text>Velocity</text>  
        </y_column>	
    </control_curve>
  …

Attributes

Attributes <flags>
Info Flags are optional, and are used to modify the behavior/appearance of the control_curve. Only 1 flag is currently defined: XY_USEDATE. When this flag is set, the x column becomes a date/time calendar.
Values XY_USEDATE
Versions 2
Used by control_curve
Attributes <max_row_count>
Info Used to set the maximum number of rows allowed in a table or curve.
Values integer
Versions 3
Used by table, control_curve
Attribute <unique_name>
Info

A unique name given to an widget, which determines how to reference the widget. This is needed if the widget is being used as a dependency (parent), or if the widget value is being exported. When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name. The name must contain at least 1 non-numeric letter. The name must be unique. Names are not case sensitive, hence “aaa” is the same as “AAA”.

Values string (unique)
Version 1
Used by card, text_box, combo_box, edit_box, table, all elements starting with “custom_control”, check_box, text_box, control_curve