Interface: ScaleSchema¶

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

A scale is a widget with a repeated set of icons, where the number of shaded represents a numeric value. The canonical example of a scale is a star rating, which might show 5 star icons, with 3 of them shaded, indicating a value of 3.

Extends¶

BaseNumberSchema<Scale>

Properties¶

codaType¶

codaType: Scale

Instructs Superhuman Docs to render this value as a scale.

Overrides¶

BaseNumberSchema.codaType

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

icon?¶

optional icon: ScaleIconSet

The icon to render.

maximum?¶

optional maximum: number

The number of icons to render.

type¶

type: Number

Identifies this schema as relating to a number value.

Inherited from¶

BaseNumberSchema.type