Properties

If no Properties name Option is given, this Action returns a PairsList of each Properties name with its value. This can only be performed with single Objects.

Otherwise, if a Properties name Option is given, this Action returns a PairsList of each Object's name with its value. This can be done with an Object or ObjectList.

In either case, if a second (assignment or value modifier) Option and an Argument are also given, then the value changes, and the names of the modified Objects are output.

Refer to unpacking the Properties Action for more details.

Applies to the EV file, Document, Platform, Transducer, Surface, Exporter and Variable Objects (that have Properties settings in their Properties dialog box). Use the Properties Information window in tandem with the Dataflow window to discover available Property names.

See also, use of keywords Default and None.

The Properties action has an option called Export, which exports all the Properties to a text file. This is separate from the Exporter object Export action.

Syntax

ObjectsMatcher | Properties [Option [Option | Argument]]

Examples

Output the properties for a variable as a PairsList.

> Calibration subset | Properties

4DBackground | SeaAndSky |

4DConstrainMinimumSampleSize | true |

4DDownsamplePings | true |

...

Output the PairsList for a Properties Option, then change the value.

> Region statistic | Properties ThresholdedValuesSetTo

Region statistic | Zero

> Region statistic | Properties ThresholdedValuesSetTo = | NoData

Region statistic

Output the PairsList for a single setting for all applicable variables, then change the value for all of them.

> * | Properties ThresholdedValuesSetTo

Fileset1: angular position raw pings T1 | Zero |

Fileset1: Power dB raw pings T1 | Zero |

Fileset1: Sv raw pings T1 | Zero |

...

> * | Properties ThresholdedValuesSetTo = | NoData

Fileset1: angular position raw pings T1 | Fileset1: Power dB raw pings T1 | Fileset1: Sv raw pings T1 | ...

Add (or subtract) a numerical PairsList value.

> * | Properties CustomLineDisplayThickness += | 1

Fileset1: angular position raw pings T1 | Fileset1: Power dB raw pings T1 | Fileset1: Sv raw pings T1 | ...

Change a color value.

> Ev File | Properties EchogramLineColorBad

Ev File | (255,0,255)

> EchogramLineColorBad = | 255,0,0

Ev File

Options that require integer values will always floor assigned real numbers.

> Calibration subset | Properties CustomGridLabelFontSize = | 8.8

Calibration subset

> Calibration subset | CustomGridLabelFontSize

Calibration subset | 8

SpacedList values that contain spaces require quotes.

> Ev File | Properties PingStatusNames 2 = | "High SNR"

Ev File

> PingStatusNames

Ev File | "" "" "High SNR" "" "" ""

Name and DynamicName

Both Name and DynamicName are expressed as a string whose characters are restricted to characters allowed in variable names. The Command interface ignores spaces between characters - spaces improve the readability of commands. The use of special or illegal characters is flagged with a message. Arrangements of characters and spaces that accidentally or intentionally contain keywords may be amended with a bracketed number or underscores to avoid ambiguity in the command.

Name

Objects support the use of a Name property which accesses the Name setting on a Name and Notes page of a Properties dialog box. The use of the keyword Default with the Name property assigns the default variable name - this is equivalent to the use of the Reset button on the Properties dialog box.

Note, when a dynamic name is used, via a dialog box or the command interface, the Name Property becomes read-only.

DynamicName

Some objects may support the DynamicName property that is equvialent to the use of the settings Dynamic with Name on the Name and Notes page of a Properties dialog box. Use the Properties Information window in tandem with the Dataflow window to discover available Property names.

To go back to using a Name (that is not dynamic), assign DynamicName to the keyword None.

To return to using a dynamic name, use the Action ResetDynamicName.

Example

Refer to the example using Name, DynamicName, ResetDynamicName and the keywords Default and None.

Multiple platforms

Echoview supports multiple platforms. Platform settings are supported under Properties for platform, transducer, position and video and image objects.

Echoview-created platforms may have names that include the text for the associated fileset name. When using the command interface, such platform names can omit the fileset name, and be aware that the (Echoview) initially-assigned fileset name may automatically update when that fileset's name is changed.

Object	Description
Platform	The Property CreatedByFileset is read-only and represents Fileset on the Platform Properties dialog box. The Property Name represents Name on the Platform Properties dialog box.
Transducer	The Property CreatedByFileset is read-only and represents Fileset on the Transducer Properties dialog box. The Property Platform represents Platform on the Transducer Properties dialog box.
Position	The Property OverridePlatform represents Override platform under the Transects section on the Cruisetrack Display page of the Variable Properties dialog box. The Property Platform reprersents Platform under the Transects section on the Cruisetrack Display page of the Variable Properties dialog box.
Video or image	The Property Platform represents Platform on the Media Position page of the Variable Properties dialog box.

Notes:

Prior to Echoview 15 the Property HeaveSource was known as HeaveLine.