Skip to content

Interface: ScaleSchema

core.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.

Hierarchy

  • BaseNumberSchema<Scale>

ScaleSchema

Properties

codaType

codaType: Scale

Instructs Coda to render this value as a scale.

Overrides

BaseNumberSchema.codaType

Defined in

schema.ts:458


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


icon

Optional icon: ScaleIconSet

The icon to render.

Defined in

schema.ts:462


maximum

Optional maximum: number

The number of icons to render.

Defined in

schema.ts:460


type

type: Number

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type

Defined in

schema.ts:250