FooterReadoutItem

A reading in the bar: a short text the environment reports, never merged with another environment's.

@internote/canvas-sdkInterface
On this page
import { FooterReadoutItem } from '@internote/canvas-sdk';

#Fields

align
leadingtrailing
Default'leading'
busy
Whether something is under way, drawn as a turning ring in the glyph's place.
boolean
icon
A glyph before the text.
crossdashplaypauseplusremovesettingslockeyeeyeOffchevronDownchevronUpchevronLeftchevronRightcheckzoomInzoomOutzoomResetreset
idRequired
Unique within the environment's contribution.
string
math
Whether text is LaTeX, typeset as maths.
boolean
rule
A measuring rule this many pixels wide, drawn before the text, as a map's scale bar is.
number
textRequired
What it reads.
string
tone
The text's tone: quieter, or coloured for a verdict.
mutederrorsuccess
typeRequired
Marks the item as a readout.
'readout'

#Example

{ type: 'readout', id: 'scale', text: '500 km', rule: 64, align: 'trailing' }

Declared in packages/canvas-sdk/src/footer/index.ts:36.

Last updated