Home arrow Reference arrow SelectByCaptions

CONTENT WARNING

This site refers to our older, server-based product. If you are interested in our new, Excel-based product, please see our main web site at http://www.nextanalytics.com

SelectByCaptions
This function locates row labels or text columns that have a matching text pattern and selects the rows.

Syntax:

SelectByCaptions, filterAction, axis, index, boolFromPage, pageCaption, boolFromFile, filename, boolFromText, operator, count, commaDelimitedCaptions

Parameters:

filterAction – action to take on items that meet criteria { KeepBySel, RemoveBySel, JustSelect, Flag}

axis – the axis for the function to operate on { Row, Column }

index – the text column index to act on, -1 to use the row label

boolFromPage – use row labels from another page (true) or not (false)

pageCaption – the caption of the page to use as a reference

boolFromFile – use a file of text strings to use as a reference (true) or not (false)

filename – the file name to use (from the myImportedData directory specified in the variables file)

boolFromText – use the text in the

captionsList (true) or not (false)

operator – the test operator to use { ExactMatch, Contains, StartsWith, EndsWith }

count – the number of items in the captionsList

commaDelimitedCaptions – a comma-separated list of captions

Examples:

SelectByCaptions,KeepbySel,Row,-1,false,,false,,true,contains,2,2006,2007

Keeps the rows with a row label that contains the text ‘2006’ or ‘2007’.

SelectByCaptions,RemovebySel,Row,-1,True,ref,false,,false,exactmatch,0,

Removes the rows with row labels that match exactly  the row labels on the page ‘ref’.

Comments:

Flag only works for the Row axis, and inserts a Flag column to the left of the column being tested.
 

Reference

Installation - Java