Stacks API

Come build with us.
Stacks API v10 for Stacks 3.5


  <  


Number — number

This content is open source. You can edit it and submit a pull request on GitHub.
This page is generated from this file.


© . YourHead Software all rights reserved.

Number — number

Available: Stacks API v8

A text entry field that validates only numbers in an allowed range. There are up/down arrows next to text entry to increment/decrement the number.

New

Number Control Array

Number controls can be used in arrays. Each has its own subtitle and default, all other values are shared.

NB: number-3 requires Stacks API v8 (Stacks v3.1+), 2 & 4 require v7 (Stacks v3.0+), single control requires v2.

Number control types are:


Minimum

The minimum value for the slider.


Maximum

The maximum value for the slider.


Rounding

If rounding is enabled then the returned values will be integers. When disabled returned values will be floating point. Rounding is enabled by default

Note: because rounding is enabled by default, you must include this key and set it to False in order to disable rounding.




Units

The units string is displayed next to the slider value. The units is strictly for the user interface, it will not be included in template output value.


Default Value

When the stack is placed onto the page the default value will be used. If no default is provided, 0 will be used.




Clear Value

When all the content is cleared out of a text input area (the user deletes all the text), the control will automatically fill with this value. This is useful for applications where a non-empty string is required.


ID

The ID for this control. This ID must be unique within this stack. The ID is used to refer to control’s property. IDs should be alpha-numeric (dashes and underscores are allowed), but should not contain special characters.




Title

The title displayed next to the control. Long titles will be truncated, so keep it short.




Enable

Hide or show the control based on the value of another property.

Enables allow a stack to show only the controls needed by the user to achieve a specific task.

The enable dictionary defines the ID of another control and the value that other control must equal. When the other control’s value is not equal to the provided value, this control is hidden.

Enable Dictionary

Enable Operations

Warning: creating infinite loops in enable dependencies has undefined behavior. It will likely result in a RapidWeaver crash.

NB: macOS does not specify the wildcard characters available or how they function. * and ? clearly work as they do in a UNIX shell. you’ll just have to guess at the rest.




Tool Tip

The tooltip value is used to display hints for the user on the use of each control. If the function of the control is obvious, then a tooltip should be avoided. Simply re-displaying redundant information like the title has no value to the user.




Subtitles

Subtitles are displayed under the control. Subtitles are unique for each item in a control array. You should provide one for each item in the control array. In the plist the subtitles should be an array of Subtitle strings. Note that some controls have very little space, so only very short subtitles can be used.




Scope

New

The scope of a property can be set to bind to the page instead of each stack. Binding a property to the page-scope means that the values set by this control will be shared between all stack-instances on the page.




Inheritance

New

Inheritance allows one stack to pull in the controls and properties of another stack. All of the controls from the specified stack are pulled in to the current stack. The inherited controls will be ordered as if they were they were first in the plist customItems array. The value should be the ID of the stack to inherit from.




© . YourHead Software all rights reserved.