Skip to content

Interface: NumericSchema

core.NumericSchema

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

Hierarchy

  • BaseNumberSchema

NumericSchema

Properties

codaType

Optional codaType: Percent

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

Overrides

BaseNumberSchema.codaType

Defined in

schema.ts:261


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


precision

Optional precision: number

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

Defined in

schema.ts:263


type

type: Number

Identifies this schema as relating to a number value.

Inherited from

BaseNumberSchema.type

Defined in

schema.ts:250


useThousandsSeparator

Optional useThousandsSeparator: boolean

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

Defined in

schema.ts:265