Skip to content

Interface: NumericSchema

Defined in: schema.ts:323

A schema representing a return value or object property that is a numeric value, i.e. a raw number with an optional decimal precision.

Extends

  • BaseNumberSchema

Properties

codaType?

optional codaType: Percent

Defined in: schema.ts:325

If specified, instructs Coda to render this value as a percentage.

Overrides

BaseNumberSchema.codaType


description?

optional description: string

Defined in: schema.ts:285

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


precision?

optional precision: number

Defined in: schema.ts:327

The decimal precision. The number will be rounded to this precision when rendered.


type

type: Number

Defined in: schema.ts:314

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type


useThousandsSeparator?

optional useThousandsSeparator: boolean

Defined in: schema.ts:329

If specified, will render thousands separators for large numbers, e.g. 1,234,567.89.