Interface: ProgressBarSchema¶

A schema representing a return value or object property that is a number that should be rendered as a progress bar.

Extends¶

codaType: ProgressBar

Instructs Superhuman Docs to render this value as a progress bar.

BaseNumberSchema.codaType

optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

BaseNumberSchema.description

optional maximum: string | number

The maximum value selectable by this progress bar (supports number or formula).

optional minimum: string | number

The minimum value selectable by this progress bar (supports number or formula).

optional showValue: boolean

Whether to display the underlying numeric value in addition to the progress bar.

optional step: string | number

The minimum amount the progress bar can be moved when dragged (supports number or formula).

type: Number

Identifies this schema as relating to a number value.

BaseNumberSchema.type