Skip to content

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

ProgressBarSchema

Properties

codaType

codaType: ProgressBar

Instructs Coda to render this value as a progress bar.

Overrides

BaseNumberSchema.codaType

Defined in

schema.ts:409


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

schema.ts:215


maximum

Optional maximum: string | number

The maximum value selectable by this progress bar.

Defined in

schema.ts:413


minimum

Optional minimum: string | number

The minimum value selectable by this progress bar.

Defined in

schema.ts:411


showValue

Optional showValue: boolean

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

Defined in

schema.ts:417


step

Optional step: string | number

The minimum amount the progress bar can be moved when dragged.

Defined in

schema.ts:415


type

type: Number

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type

Defined in

schema.ts:250