Global actions for layers
pw:: | Global actions for layers |
Static Actions | |
getCount | This action gets the number of layers. |
getDescription | This action gets a layer’s description. |
setDescription | This action sets a layer’s description. |
getLayerEntityCounts | This action gets the number of entities in a layer. |
getLayerEntities | This action returns the entities in a layer. |
move | This action moves the given source list of layers into the given target list of layers. |
getStateCount | This action gets the number of saved states. |
getState | This action gets the name of the given saved state. |
getStateCurrentLayer | This action gets the current layer of the given saved state. |
getStateShownCount | This action gets the number of shown layers of the given saved state. |
getStateHiddenCount | This action gets the number of hidden layers of the given saved state. |
saveState | This action saves the layer visibility state of the curent display. |
restoreState | This action restores the layer visibility state to the curent display. |
removeState | This action removes the save state from the list of saved states. |
renameState | This action renames the save state. |
pw::Layer getCount
This action gets the number of layers.
None
This action returns the integer number of layers.
pw::Layer getLayerEntityCounts ?-enabled enabledVar? ?-disabled disabledVar? number
This action gets the number of entities in a layer.
-enabled enabledVar | This optional parameter is a string variable name to receive a list of integers giving the number of enabled entities in the layer. |
-disabled disabledVar | This optional parameter is a string variable name to receive a list of integers giving the number of disabled entities in the layer. |
number | This parameter is the integer layer number with the range [0, number of layers). |
This action returns a list of integers giving the number of entities in the layer.
The list of integers represent the count of the entities in the layer in the following order: blocks, domains, connectors, database and source entities.
pw::Layer getLayerEntities ?-type type_string? number
This action returns the entities in a layer.
-type type_string | If specified, this option filters the result to include only entities of the specified type. Only types derived from pw::GridEntity, pw::DatabaseEntity or pw::SourceEntity are valid. |
number | This parameter is the integer layer number with the range [0, number of layers). |
This action returns a list of pw::GridEntity, pw::DatabaseEntity and pw::SourceEntity objects in the layer.
pw::Layer move ?-description? ?-visibility? source_list target_list
This action moves the given source list of layers into the given target list of layers. If the source list is longer than the target list, additional source layers will be moved into the last target layer.
-description | This optional flag indicates to move the description of the layer. |
-visibility | This optional flag indicates to move the visibilty of the layer. |
source_list | This parameter is the list of integer layer numbers to move. The integers must be in the range [0, number of layers). |
target_list | This parameter is the list of integer layer numbers to move into. The integers must be in the range [0, number of layers). |
This action returns nothing.
pw::Layer getStateCount
This action gets the number of saved states.
None
This action returns the integer number of saved states.
pw::Layer saveState ?name?
This action saves the layer visibility state of the curent display.
name | This optional parameter is the string name to give this state for referring to it in other actions; if no name is given, a unique name will be generated. |
This action returns nothing.
pw::Layer restoreState name
This action restores the layer visibility state to the curent display.
name | This parameter is the string name of the state to restore. |
This action returns nothing.
pw::Layer removeState name
This action removes the save state from the list of saved states.
name | This parameter is the string name of the state to remove. |
This action returns nothing.
This action gets the number of layers.
pw::Layer getCount
This action gets a layer’s description.
pw::Layer getDescription number
This action sets a layer’s description.
pw::Layer setDescription number description
This action gets the number of entities in a layer.
pw::Layer getLayerEntityCounts ?-enabled enabledVar? ?-disabled disabledVar? number
This action returns the entities in a layer.
pw::Layer getLayerEntities ?-type type_string? number
This action moves the given source list of layers into the given target list of layers.
pw::Layer move ?-description? ?-visibility? source_list target_list
This action gets the number of saved states.
pw::Layer getStateCount
This action gets the name of the given saved state.
pw::Layer getState index
This action gets the current layer of the given saved state.
pw::Layer getStateCurrentLayer name
This action gets the number of shown layers of the given saved state.
pw::Layer getStateShownCount name
This action gets the number of hidden layers of the given saved state.
pw::Layer getStateHiddenCount name
This action saves the layer visibility state of the curent display.
pw::Layer saveState ?name?
This action restores the layer visibility state to the curent display.
pw::Layer restoreState name
This action removes the save state from the list of saved states.
pw::Layer removeState name
This action renames the save state.
pw::Layer renameState old_name new_name