pw:: Layer

Global actions for layers

Summary
Global actions for layers
This action gets the number of layers.
This action gets a layer’s description.
This action sets a layer’s description.
This action gets the number of entities in a layer.
This action returns the entities in a layer.
This action moves the given source list of layers into the given target list of layers.
Thsi action gets the number of saved states.
This action gets the name of the given saved state.
This action gets the current layer of the given saved state.
This action gets the number of shown layers of the given saved state.
This action gets the number of hidden layers of the given saved state.
This action saves the layer visibility state of the curent display.
This action restores the layer visibility state to the curent display.
This action removes the save state from the list of saved states.
This action renames the save state.

Static Actions

getCount

pw::Layer getCount

This action gets the number of layers.

Parameters

None

Returns

This action returns the integer number of layers.

getDescription

pw::Layer getDescription number

This action gets a layer’s description.

Parameters

numberThis parameter is the integer layer number; [0, number of layers).

Returns

This parameter returns a string.

setDescription

pw::Layer setDescription number description

This action sets a layer’s description.

Parameters

numberThis parameter is the integer layer number; [0, number of layers).
descriptionThis parameter is a string description.

Returns

This action returns nothing.

getLayerEntityCounts

pw::Layer getLayerEntityCounts ?-enabled enabledVar? ?-disabled disabledVar? number

This action gets the number of entities in a layer.

Parameters

-enabled enabledVarThis optional parameter is a string variable name to recieve a list of integers giving the number of enabled entities in the layer.
-disabled disabledVarThis optional parameter is a string variable name to recieve a list of integers giving the number of disabled entities in the layer.
numberThis parameter is the integer layer number; [0, number of layers).

Returns

This action returns a list of integers giving the number of entities in the layer.

Information

The list of integers represent the count of the entities in the layer in the following order: blocks, domains, connectors, database and source entities.

getLayerEntities

pw::Layer getLayerEntities ?-type type_string? number

This action returns the entities in a layer.

Parameters

numberThis parameter is the integer layer number; [0, number of layers).  -type type_string If specified, this option filters the result to include only entities of the specified type.  Only types derived from pw::GridEntity or pw::DatabaseEntity are valid.

Returns

This action returns a list of pw::GridEntity and <pw::DatabaseEntiy> in the layer.

move

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.

Parameters

-descriptionThis optional flag indicates to move the description of the layer.
-visibilityThis optional flag indicates to move the visibilty of the layer.
source_listThis parameter is the list of integer layer numbers to move; [0, number of layers).
target_listThis parameter is the list of integer layer numbers to move into; [0, number of layers).

Returns

This action returns nothing.

getStateCount

pw::Layer getStateCount

Thsi action gets the number of saved states.

Parameters

None

Returns

This action returns the integer number of saved states.

getState

pw::Layer getState index

This action gets the name of the given saved state.

Parameters

indexThis parameter is the integer index of the save state to get; [1, number of states].

Returns

This action returns the string name of the state.

getStateCurrentLayer

pw::Layer getStateCurrentLayer name

This action gets the current layer of the given saved state.

Parameters

nameThis parameter is the string name of the save state.

Returns

This action returns the integer layer number that will be current when the state is restored.

getStateShownCount

pw::Layer getStateShownCount name

This action gets the number of shown layers of the given saved state.

Parameters

nameThis parameter is the string name of the save state.

Returns

This action returns the integer number of layers that will be shown when the state is restored.

getStateHiddenCount

pw::Layer getStateHiddenCount name

This action gets the number of hidden layers of the given saved state.

Parameters

nameThis parameter is the string name of the save state.

Returns

This action returns the integer number of layers that will be hidden when the state is restored.

saveState

pw::Layer saveState ?name?

This action saves the layer visibility state of the curent display.

Parameters

nameThis 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.

Returns

This action returns nothing.

restoreState

pw::Layer restoreState name

This action restores the layer visibility state to the curent display.

Parameters

nameThis parameter is the string name of the state to restore.

Returns

This action returns nothing.

removeState

pw::Layer removeState name

This action removes the save state from the list of saved states.

Parameters

nameThis parameter is the string name of the state to remove.

Returns

This action returns nothing.

renameState

pw::Layer renameState old_name new_name

This action renames the save state.

Parameters

old_nameThis parameter is the string name of the state to rename.
new_nameThis parameter is the string name to change the state name to.

Returns

This action returns nothing.

pw::Layer getCount
This action gets the number of layers.
pw::Layer getDescription number
This action gets a layer’s description.
pw::Layer setDescription number description
This action sets a layer’s description.
pw::Layer getLayerEntityCounts ?-enabled enabledVar? ?-disabled disabledVar? number
This action gets the number of entities in a layer.
pw::Layer getLayerEntities ?-type type_string? number
This action returns the entities in a 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.
pw::Layer getStateCount
Thsi action gets the number of saved states.
pw::Layer getState index
This action gets the name of the given saved state.
pw::Layer getStateCurrentLayer name
This action gets the current layer of the given saved state.
pw::Layer getStateShownCount name
This action gets the number of shown layers of the given saved state.
pw::Layer getStateHiddenCount name
This action gets the number of hidden layers of the given saved state.
pw::Layer saveState ?name?
This action saves the layer visibility state of the curent display.
pw::Layer restoreState name
This action restores the layer visibility state to the curent display.
pw::Layer removeState name
This action removes the save state from the list of saved states.
pw::Layer renameState old_name new_name
This action renames the save state.
An integer is a whole number.
A string is an array of characters.
A type is the class name of a Glyph2 object.
Base type for all database entities