pteIsVisible

pteIsVisible(
{ t_layerPurposeName | t_paletteElementPath }
t_panelName
[ w_windowId ]
) 
=> t / nil

Description

Retrieves the visibility state for the specified layer-purpose pair, object, or grid.

Arguments

t_layerPurposeName
	Layer-purpose pair, object, or grid name.
t_paletteElementPath
	Path to the layer-purpose pair, object, or grid for which you want to retrieve the visibility state.
t_panelName	Name of the Palette panel. Valid values: Layers, Objects, and Grids
w_windowId	ID of the window that contains the Palette from which you want to retrieve data. Valid values: ID of any open window Default: Current window

Value Returned

t	The specified layer-purpose pair, object, or grid is set to visible.
nil	The specified layer-purpose pair, object, or grid is not set to visible.

Examples

• When View By is set to None:
  

  pteIsVisible("prBoundary boundary" "Layers")

  pteIsVisible("prBoundary boundary" "Layers" window(2))

• When View By is set to Layer:
  

  pteIsVisible("prBoundary;prBoundary boundary" "Layers")

• When View By is set to Purpose:
  

  pteIsVisible("boundary;prBoundary boundary" "Layers")

Related Topics

pteSetVisible

Return to top