This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon

Pattern


Attribute Data Type: 

Attribute Default Value: 

Attribute Group: 

Attribute Purpose: 

Attribute Inherited from Preferences?   

Attribute Read-Only? 

Attribute Intrinsic? 

Attribute First Added: 

Attribute Altered: 

 string   [other string-type attributes]

 solid

 Appearance   [other Appearance Group attributes]

 Visual configuration

 No

 No

 No

 Already in v5.0.0

 5.10.1, 5.12.0


Optional pattern to be drawn on the face of icons in Map view.

These patterns look best when the two colours are similar but not identical. The keywords are case-sensitive. Originally the default value was an empty string but in v5.10.1 this changed to 'diagonal'. In v5.10.1 this changed to 'solid' - which equates to 'plain'. The current default is 'plain', as at v5.12.0.

If $Pattern is plain no pattern is applied and the note face is drawn in solid $Color.

If $Pattern is lines, the face of the note is filled with alternative horizontal lines of $Color and $Color2.

If $Pattern is gradient, the face of the note is filled with a linear colour gradient, top to bottom, from $Color to $Color2.

If $Pattern is diagonal, the face of the note is filled with a linear colour gradient, running from upper-left to lower-right corner, from $Color to $Color2.

If $Pattern is cylinder, the face of the note is filled with a cylindrical gradient, running from $Color at the top through $Color2 at the midpoint, and then to $Color again at the bottom.

If $Pattern is radial, the face of the note is a graduation from $Color at 1/3 in from top-left through $Color2 toward all edges.

If $Pattern is not set (empty string), no pattern is applied and equating to plain.

The remaining four patterns can't be set via the Pattern menu; bar(), vbar(), bargraph() and plot(). Rather they are set via manual editing of this attribute (Info view, key attribute) or via actions, rules, stamps. etc., acting upon it.

bar([value],[min],[max]). The draws as a horizontal 'progress bar', using $Color and $Color2. The 'progress' block is drawn in $Color2.

vbar([value],[min],[max]). The draws as a vertical 'progress bar', using $Color and $Color2. The 'progress' block is drawn in $Color2.

In both cases the parameters work the same way:

The arguments in the brackets may be numbers or expressions that can be evaluated as numbers. If a note's width is 3.0, then bar(15*$Width) is the same as writing bar(45).

If the pattern is written without parameters or brackets, it evaluates as if at 50%, e.g. vbar() and vbar are the same as vbar(50).

There are 2 further patterns, only used for Map view container plots: bargraph() & plot(). The patterns use the same parameters/syntax as bar()/vbar() above. The container then draws a plot over the top of its viewport area showing the value of the stated attribute (or expression) for each immediate child. The bargraph() gives a bar graph, and plot() a sparkline type plot. Containers only have one $Pattern value so can show a pattern either in the main icon or a container plot, but not both.


Possible relevant notes (via "Similar Notes" feature):


A Tinderbox Reference File : Attributes : Attribute Data Types : String Attributes : Pattern