Product Documentation
Select a Product:
Find Text:
Submit a question:
Not seeing an answer to a question you might have? You can ask it here and we'll try to update the documentation to address it. If you're making a feature request or reporting a problem, please create a support item for it, instead!
Number-line
Purpose
The number-line visual lets you visualize numbers on a line, illustrating relative value, progress, and much more. Numbers have associated textual descriptions. The number-line places text intelligently, for readability, using lines to connect text back to points on the number-line. It's possible to group values by tens, hundreds, thousands, and so on, to reduce layout busyness. Values can be discrete points on the number-line (represented by "bullets"), or have both start and end values (represented by a wider bar on the number-line). Other options are available to control coloring, display of images, layout direction, and categories of values.
Data Bucket
The data requirements for the Number-line include 8 bucket fields, listed here:
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Number Source | Numeric | A number that should appear on the number-line, either as a discrete value, or grouped with other values. | ||||||||||||||||
| Milestone Text | Text | A text description to associate with the number. | ||||||||||||||||
| Milestone Color (optional) | Text | If provided, controls the color of the bullet and/or text. It should be a valid web color. Invalid colors or an empty value will use the default color. | ||||||||||||||||
| End Value (optional) | Numeric | When provided, changes the display of the value from a discrete point on the line, to an elongated bullet that spans the start-to-end value range. | ||||||||||||||||
| Image Source (optional) | Text | If provided, needs to be of the form "data:image/XXXX;base64,YYYY", where XXXX is a valid image format (e.g. "png"), and YYYY is the base64 encoded version of the image binary content. Note: you can easily turn an actual image into its base64 encoded format using on-line tools such as https://www.base64-image.de. There is a size limit of approximately 20Kb. | ||||||||||||||||
| Category (optional) | Text | If provided, acts as a clickable label within the layout to show details, or it can be a static header for all events that share the same category, in a given time block. | ||||||||||||||||
| Category Color (optional) | Text | If provided, controls the color of the category label. It should be a valid web color. Invalid colors or an empty value will use the default color. | ||||||||||||||||
| Value Formatting Expression (optional) | Text |
If provided, should combine one or more formatting terms. Multiple formatting terms can be separated with semi-colons. Formatting terms are name/value pairs, with the setting name, followed by a colon, followed by a value. Supported formatting settings include:
|
Settings
Data and Interaction
| Field | Default | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Summary Level | None |
Specifies if/how to group values. Options include:
| ||||||||||
| Unit of Measure | Provide a unit for the value, if applicable. Supported units can be found in Unicode Technical Standard #35. | |||||||||||
| Scaling Unit | Specifying a value greater than 1 changes the scale of the line such that each value's relative position (between minimum and maximum value) is raised to the 1/n power, where "n" is the scaling unit. | |||||||||||
| Maximum Markers | 500 | Reducing this value allows you to truncate values during layout (ie. it not necessary to do this in the source data). (Value cannot exceed 500.) | ||||||||||
| Truncate for latest | True | When true, any data truncation based on "Maximum Markers" is applied to the smallest values; otherwise, truncation is applied to the greatest values. | ||||||||||
| Show Tool-tips | True | When true, hovering over bullets shows a tool-tip for related values. | ||||||||||
| Minimum Value | When specified, becomes the start value for the number-line, if it is less than the smallest value. It will also exclude values from layout if they are less than the minimum value. | |||||||||||
| Maximum Value | When specified, becomes the end value for the number-line, if it is greater than the greatest value. It will also exclude values from layout if they are greater than the maximum value. |
Formatting
| Field | Default | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Locale Override | When left blank, uses the client's locale setting. When provided explicitly, must be a well-known locale code (a BCP 47 language tag). Changes layout rules for numbers to match the desired locale. | |||||||||||
| Number Format | Number |
Identifies the display rules for values. Can be one of:
| ||||||||||
| Currency Code | USD | If the numeric values are currency, indicates the currency type, in ISO 4217 currency code format. | ||||||||||
| Maximum Decimal Places | Determines the maximum number of decimal places to show. If omitted, the visual determines the ideal precision. | |||||||||||
| Minimum Decimal Places | Determines the minimum number of decimal places to show. If omitted, the visual determines the ideal precision. | |||||||||||
| Line Orientation | Horizontal |
Options include: "Horizontal" - number-line is rendered horizontally "Vertical" - number-line is rendered vertically, with the earliest date at the top "Vertical Reversed" - number-line is rendered vertically, with the latest date at the top | ||||||||||
| Distribution Style | Top-Bottom | Controls where event text can be placed. "Top-Bottom" allows text to appear both above and below the number-line, in alternating fashion. "Top" or "Bottom" constrains text to either of these placements. | ||||||||||
| Show Text | True | When set to False, only the number-line and bullets are rendered - no text. | ||||||||||
| Show Count Label | True | When set to True, a count of values will be shown below the number-line. | ||||||||||
| Markers Must Terminate | False | When disabled (default), the line may extend before the first marker or after the last marker, in grouped scenarios (start is minimum value, end is maximum value). When enabled, markers will always be at the start and end of the line. | ||||||||||
| Use Compact Display | False | When enabled, abbreviates values using suffixes such as K (thousands) and M (millions). | ||||||||||
| Use Accounting Format | False | When enabled, negative numbers are shown using accounting formatting. | ||||||||||
| Show Long Units | False | When off, abbreviated unit names will be shown. | ||||||||||
| Append Range Text | False | When enabled, appends the start and end values when available, to each text entry. | ||||||||||
| Show Titles | True | When disabled, does not show title text. | ||||||||||
| Show Grouped Format | Only for Multiple | Controls how values are shown when they are part of a group. "Only for Multiple" means group formatting rules only applies when there is more than one value within the group. "Always" and "Never" are other options. | ||||||||||
| Grouped Format | Date |
When the "Show Grouped Format" rule determines that formatting should be applied, controls if any of these elements should be applied: "Value" - show the value in front of the descriptive text, within a group. "Line" - include a line between values within a group. "Number" - includes a sequential number in front of the text, within a group. "None" - suppresses any additional formatting within groups. | ||||||||||
| Grouped Sorting | Ascending | For multiple values within a group, determines how they are sorted. | ||||||||||
| Grouped Value Style | Italics | If group formatting includes either "Value" or "Number", determines any additional formatting to apply to these display elements. | ||||||||||
| Category Format | Expandable |
If a category has been applied in the data bucket, controls how the category text is used within the layout. Can be: "Expandable" - only the category text will be shown, and clicking the category text will toggle between expanded and collapsed display of the detailed events under that category, within the group. "Only Category" - only the category text will be shown (will not be expandable) "Always Show (both)" - the same behavior is achieved as "expandable" with all items expanded initially, and no ability to toggle. "Line per Category" - different categories produce different number-lines, the formatting of each controlled by other settings. (Only supported with horizontal orientation.) | ||||||||||
| Group Marker Placement | Average |
For multiple values within a group, determines where the marker is placed. Based on all values within the group, can be one of: "Average", "Minimum", "Maximum", "Median", "Mid-point", "Start of Group" | ||||||||||
| Group Measures | None |
For groups with multiple values, you have the option to show additional measures. These can be: "None", "Average", "Median", "Placement Value" "Placement Value" shows the value based on the group marker placement setting. | ||||||||||
| Group Measure Style | None | Allows you to change the font style for any group measure that is shown. | ||||||||||
| Measure Font Size | 10 | Controls the font size for any group measure that is shown. | ||||||||||
| Range Display Style | Start, End Inclusive |
Controls how aggregated ranges are labeled. Options include: "Start Only" - only the start value is shown "Start, End Inclusive" - start and end are shown but the end value is inclusive of the next range "Start, End Exclusive" - start and end are shown, with the end reduced by the smallest amount necessary "Use >= and <" - the end inclusive value can be shown since "less than" is noted | ||||||||||
| Range Display Separator | - | Allows control over the text to show between start and end-of-range values when using range styles that include both values. | ||||||||||
| Line per Category Placement | Left | When using "Line per Category," determines where the category label is placed in relation to the category number-line. | ||||||||||
| Category Share Scale | False | When true, all category number-lines share the same start and end dates. If false, each number-line starts and ends with dates determined by each category's events. | ||||||||||
| Line per Category Font Size | 11 | Controls the category label text size when using "Line per Category." | ||||||||||
| Line per Category Style | None |
When using "Line per Category," determines how different category number-lines are delimited. Options include: "None" - no delimiter is used "Line" - a line is used to separate category number-lines "Boxed" - each number-line is placed in a box with a border | ||||||||||
| Line per Category Spacing | When using "Line per Category," allows the inclusion of additional white-space between category number-lines. | |||||||||||
| Line per Category Min Height | When using "Line per Category," sets a minimum height for each category number-line layout region. | |||||||||||
| Category Min Label Width | When using "Line per Category," sets a minimum width for each category label. This can be helpful to align number-lines across categories when using Left or Right for label position. | |||||||||||
| Title Text Size | 11 | Titles are the dates shown on the number-line. | ||||||||||
| Grouped Value Size | 10 | The size of any caption text. | ||||||||||
| Text Size | 10 | This represents the size of the text used for descriptions. | ||||||||||
| Item Extra Padding | 0 | Allows you to add padding to number-line entries. This can create more whitespace, thereby improving readability in many cases. | ||||||||||
| Title Extra Space | 0 | Allows you to add padding around titles (dates) on the number-line. This can create more whitespace, thereby improving readability in many cases. | ||||||||||
| Spacing From Line Override | Optionally override the spacing away from the line. | |||||||||||
| Minimum Text Width | The minimum content width for text. (If omitted, uses a default.) | |||||||||||
| Maximum Label Width | Can be used to fine-tune layout, especially when dealing with longer descriptions. Default/unset has a value picked based on a best guess for effective layout. | |||||||||||
| Main Line Thickness | 3 | Controls how thick the main number-line is. | ||||||||||
| Bullet Style | Hollow Square | Controls how bullets are displayed on the number-line. Choices include: "None", "Hollow Square", "Hollow Circle", "Solid Square" and "Solid Circle". Note: including end values in your layout with circular bullets means it is possible that your stretched bullets will appear more like ellipses. | ||||||||||
| Bullet Size | 2.5 | Controls the central size of bullets on the number-line. | ||||||||||
| Bullet Border | 3 | Controls the size of the border for bullets. | ||||||||||
| Maximum Image Size | 24 | When images are included in your layout, applies both a maximum width and height restriction for all images. |
Colors
| Field | Default | Description |
|---|---|---|
| Line Color | Black | The color for the main number-line. |
| Title Fore Color | Black | The color for title text (dates) on the number-line. |
| Default Bullet Fill Color | White | This value can come from source data, but when this is not present, this setting value is used as the fill color for bullets on the number-line. |
| Hollow Border Color | Black | When the bullet style is one of the "hollow" types, controls the border color for bullets. Note: solid bullets are colored based on the rules described for "Default Bullet Fill Color". |
| Group Measure Color | The color to use when a group measure is shown; default is the text color. | |
| Alt Fore Color 1/2 | Allows you to create "zebra striped" coloring of event text. To use a single color, set both 1 and 2 colors to the same color. | |
| Alt Back Color 1/2 | Allows you to create "zebra striped" background coloring of events. To use a single color, set both 1 and 2 colors to the same color. | |
| Alt Group Back Color 1/2 | Allows you to create "zebra striped" background coloring of events, within groups. (This can be used to create more visual separation of events within groups.) To use a single color, set both 1 and 2 colors to the same color. | |
| Alt Back LPC Color 1/2 | When using the "Line per Category" style, allows you to create "zebra striped" background coloring of category number-line layout regions. To use a single color, set both 1 and 2 colors to the same color. |
License
| Field | Description |
|---|---|
| Licensed By | The exact text that you used for the licensee name, when you acquired a license key. This can be found on your account profile page. |
| License Key | The exact text that you received when you acquired a license key. This can be found on your account profile page. License key use is only needed if you aren't using the free edition or AppSource licensing (ie. you're using a site license). |
Other Resources / Links:
Learn more about purchasing one or more user licenses from Microsoft AppSource.