User Guide

177
Standard NetLinx API (SNAPI) R 1.8.0
Multi Window Functions (Cont.)
Name Component Channel Level Command Constant Notes
getWindowSize() IWindowComponent ?WINDOW Query for the window size. Response with
WINDOW-<x>,<y>,<height>,<width>
getZOrder() IWindowComponent ?WINDOWZORDER Get the Z-order. Responds with WIN-
DOWZORDER-<value> where <value> is 1
to the maximum z-order of the device, 1 is
the top-most z-order (see specific module
documentation)
pan(UP) IWindowComponent 132 PAN_UP Momentary Function Channel: Image is
moved up one step within the window when
channel is activated
pan(DOWN) IWindowComponent 133 PAN_DN Momentary Function Channel: Image is
moved down one step within the window
when channel is activated
pan(LEFT) IWindowComponent 134 PAN_LT Momentary Function Channel: Image is
moved left one step within the window
when channel is activated
pan(RIGHT) IWindowComponent 135 PAN_RT Momentary Function Channel: Image is
moved right one step within the window
when channel is activated
removeWindowComponent(windowAddress) IWindowComponent WINDOWRE-
MOVEADDR-
<address>
Remove the window with address
<address>, where <address> is a window
address
removeWindowComponent(index) IWindowComponent WINDOWRE-
MOVEIDX-<index>
Remove the window at index <index>,
where <index> is 1 through x and x is the
maximum supported window index (see
specific module documentation)
setBrightness(level) IWindowComponent 10 BRIGHT_LVL Set brightness level, range is 0-255
setColor(level) IWindowComponent 11 COLOR_LVL Set color level, range is 0-255
setContrast(level) IWindowComponent 12 CONTRAST_LVL Set contrast level, range is 0-255
setFreezeOn(state) IWindowComponent 214 PIC_FREEZE_ON Discrete Function Channel: Freeze is on
while channel is active
setImage(source, pos, size) IWindowComponent IMAGE-
<source>,<x>,<y>,<hei
ght>,<width>
Set the image source, position and size rel-
ative to the window where <source> is 1 to
the maximum source number (see specific
module documentation) and <x> and <y>
are the window coordinates for the upper-
left hand corner of the image and <height>
and <width> are the size of the image to be
displayed in the window. Used to change
the position of the image visible in the win-
dow.
setImageSource(int) IWindowComponent IMAGESOURCE-
<source>
Set the image source for the window where
<source> is 1 to the maximum source num-
ber (see specific module documentation)