Interface: ProgressBarSchema¶
core.ProgressBarSchema
A schema representing a return value or object property that is a number that should be rendered as a progress bar.
Hierarchy¶
BaseNumberSchema
<ProgressBar
>
↳ ProgressBarSchema
Properties¶
codaType¶
• codaType: ProgressBar
Instructs Coda to render this value as a progress bar.
Overrides¶
BaseNumberSchema.codaType
Defined in¶
description¶
• 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.
Inherited from¶
BaseNumberSchema.description
Defined in¶
maximum¶
• Optional
maximum: string
| number
The maximum value selectable by this progress bar (supports number or formula).
Defined in¶
minimum¶
• Optional
minimum: string
| number
The minimum value selectable by this progress bar (supports number or formula).
Defined in¶
showValue¶
• Optional
showValue: boolean
Whether to display the underlying numeric value in addition to the progress bar.
Defined in¶
step¶
• Optional
step: string
| number
The minimum amount the progress bar can be moved when dragged (supports number or formula).
Defined in¶
type¶
• type: Number
Identifies this schema as relating to a number value.
Inherited from¶
BaseNumberSchema.type