INDEX - v14

index                         <text>,kill

or

index                         <text>, {+|-}
{i=<item> {,i=(<item>,<item>...)}
{,f=<f_range>} {,f=(<f_range>,<f_range>.)}
{,m=<i>} {,m=(<n_range>,<n_range>...)}
{,$=<i>} {,$=(<n_range>,<n_range>...)}
{,th=<i>} {,th=(<n_range>,<n_range>..)}
{,font=<i>} {,font=(<n_range>,<n_range>.)}
{,col=<i>} {,col=(<n_range>,<n_range>..)}
{,til=<i>} {,til=(<n_range>,<n_range>..)}
{,ren=<i>} {,ren=(<n_range>,<n_range>..)}
{,h=<i>} {,h=(<n_range>,<n_range>...)}
{,class=<text>} {,l=<text>}
{,a<i>=<text>} {,x=<text>}

or

index                         <text>,pen=<i>

Function

To delete a given user index without deleting the items it contains.

or

Select items of particular types or with particular attributes from within the model and create a new index.

or

Draw all items belonging to an index with the given index color.

Parameters

text

Where text is the name of the user-defined index.

 

 

+

Use the command as an "include".

 

 

-

Use the command as an "exclude"

 

 

i=

Select all items of particular item types. If more than one item type is indicated, they should be enclosed within parentheses.

 

 

f=

Select all items with particular fragment numbers. If more than one fragment range is indicated, they should be enclosed within parentheses.

 

 

m=

Select all items using a particular pen number. A range may be indicated within parentheses.

 

 

$=

Select all items using a particular dash pattern. A range may be indicated within parentheses.

 

 

th=

Select all items using a particular pen thickness. A range may be indicated within parentheses.

 

 

font=

Select all items using a particular character font. A range may be indicated within parentheses.

 

 

col=

Select all items using a particular colour fill. A range may be indicated within parentheses.

 

 

til=

Select all items using a particular tiling pattern. A range may be indicated within parentheses.

 

 

ren=

Select all items using a particular render pattern. A range may be indicated within parentheses.

 

 

h=

Select all items using a particular hatch pattern. A range may be indicated within parentheses.

 

 

class=

Select all submodels with a particular classification code. If <text> is enclosed within quotes it will be a literal code. If not, it will be used as a wild-card code. The code should have a maximum of 8 characters. 

 

 

l=

Select all submodels with a particular location code. If <text> is enclosed within quotes it will be a literal code. If not, it will be used as a wild-card code. Code should have a maximum of 16 characters.

 

 

a=

Select all items whose attribute <i> is a particular code. If <text> is enclosed within quotes it will be a literal code. If not, it will be used as a wild-card code.

 

 

x=

Select all items which belong to a given index. Either a user index or one of the three system indices BACKGROUND, FOREGROUND, or PARTITION maybe specified.
 

pen=

A primer PEN allows a pen being to be associated to an index:
INDEX <name>, PEN=<pen>
If an index has a pen associated then all the items belonging to that index will be drawn with the index color.
System indices (PARTITION, BACKGROUND and FOREGROUND) have priority over user-defined indices. This means that if an item belongs to a user defined indices that has a pen associated, but it also belongs to the PARTITION index that has a pen associated, then the item is drawn using the pen associated to the PARTITION index.
If COLOR_SELECTION environment variable is defined, the pen associated to the PARTITION index overrides it. (Introduced 14.1.0)

Examples

index circuit,kill

index new_index,f=1, i=s

index new_index,i=(m,d), a1=dim*

index new_index,i=$door*, a5='green'

index new_index,class='**'

index new_index,m=(1\4), $=(1,5), th=1

index new_index,x=walls, m=3

Notes

Only items in the foreground will be selectable.
When evaluating which items are to be selected, only items which satisfy all of the conditions will be chosen.
During wild-card code comparisons, upper and lowercase characters are treated as equal.
LINES items will be split and packed if individual vector selection is necessary.

 

 

Two environment variable are available that enable drawing markers on item main points when the item enters or exits an index. The two variables are used to activate the feature and to define the index name. (Introduced 11.9-v12)

Example:
NEW_FASHION_MARKERS=yes
This variable enables the display of markers on selected items only (legacy).
MARKERS_ACTIVE_INDEX=index_name
This variable defines the user defined index used by the markers display process.

SELECTION_MARKERS_SIZE=<pixels>

Defines the sized of the selection marker in terms of pixels. (Introduced12.5.0)

 

Two environment variables have been made available to enable to temporary assignment of a colour by the system to items belonging to an index.  This is a similar function to markers

COLOR_SELECTION=0no coloring (default)
                  i pen number

COLOR_ACTIVE_INDEX = name of the index
Coloring and markers can be used together.
 

Refer to the Customizing Eagle Graphics section for details

 

See also

YESNO, attribute, hatch, classify, fragment, lines, location, partition, tile, erase