StreamFile - property of the PmgPipe object

Description:

Stream pattern.

Syntax:

String StreamFile

Note:

Property access for read and write. The default value of this property is defined in the "Pattern" configurator of this object.

It is recommended to always use the path with #pmres: or #appres:.

This property is also functional in Web panels.

- If the pattern is an empty string, then it is not displayed.

- Can be used the preset stream patters which are supplied in the PROMOTIC system in the #pmres:Img folder - see Stream - Images. Except these patterns it can be used any other pattern (file with image in the svg, png, jpg, bmp ... format).

- The pattern is expanded into the whole area of the pipeline and therefore the pattern has to be created so as it is bound smoothly to itself.

- The image must be always created so that it is oriented to the horizontal pipeline by its pattern. If this image is used in the vertical pipeline, then it is rotated by 90° before its expansion automatically.

- Each period (see StreamPeriod) the image is moved by 3 pixels, and therefore it is appropriate to use the images width of 9 or more pixels (the height can be whichever).

Example:

JavaScriptVBScriptSelect and copy to clipboard



var oPipe = pMe.Items("/Pipe");


var sStreamFile = oPipe.StreamFile;
  // Reading from the property

oPipe.StreamFile = "#pmres:Img/StreamDrop1.svg";
  // Writing into the property