Dashboards APIs

Data Model

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

finDashboard

Marker

 

Marker tag to appear in list of dashboards

dashboardOn

Str

 

Relative

content

Dict<Widget>

 

Top level Widget for the dashboard

Widget

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

type of widget which is used in inheritance

title

Str

✓

header to use for widget

Types

Grid Layout

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::GridLayout

children

*

List

Dict<Widget>

 

list of children

a widget that is laid out by this grid

layout

*

  • x

  • y

  • w

  • h

List

Dict

  • Number

  • Number

  • Number

  • Number

 

Must be same length as children

layout for equivalent item in children

rowHeight

Number

✓

Will have default if not defined

cols

  • lg

  • md

  • sm

  • xs

  • xxs

Dict

  • Number

  • Number

  • Number

  • Number

  • Number

✓

default cols: {lg: 12, md: 10, sm: 6, xs: 4, xxs: 2},

History Chart

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::HistoryChart

title

Str

✓

header to use for widget

widget

Str

 

ex. lineHis, barHis

chartOptions

  • rotate

  • download

  • layered

  • stacked

  • legend

  • filled

Dict

  • Marker

  • Marker

  • Marker

  • Marker

  • Marker

  • Marker

 

  • ✓

  • ✓

  • ✓

  • ✓

  • ✓

  • ✓

 

data

  • expr

  • proto

    • kind

  • recs

    • point

    • color

    • relative

Dict

  • Str

  • Dict[]

    • Str

  • Dict[]

    • Ref

    • Str

    • Marker

 

  • ✓

  • ✓

    •  

  • ✓

    •  

  • expr - expression to used for getting data, if not included, default is "{{recs}}.hisRead({{date}})"

  • proto - default tags to use for the data returned

  • recs - default tags to use for the data returned

    • point - id of selected point

    • color

    • relative

date

  • defVal

  • ro

Dict

  • Str

  • Marker

✓

default tags to use for the data returned

  • Anything accepted as a date, span, etc

  • If set, date can not be changed (don't show picker)

Value Chart

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::ValueChart

title

Str

✓

header to use for widget

widget

Str

 

ex. barVal

chartOptions

  • singleGauge

  • rotate

  • download

  • threeD

  • filled

  • pie

Dict

  • Marker

  • Marker

  • Marker

  • Marker

  • Marker

  • Marker

 

  • ✓

  • ✓

  • ✓

  • ✓

  • ✓

  • ✓

 

data

  • expr

  • recs

    • point

    • color

    • relative

Dict

  • Str

  • Dict[]

    • Ref

    • Str

    • Marker

  • ✓

  • ✓

    • ✓

 

Value Gauge

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::ValueGauge

widget

Str

 

ex. bar1

title

Str

✓

header to use for widget

data

  • expr

  • recs

    • point

    • color

    • relative

Dict

  • Str

  • Dict[]

    • Ref

    • Str

    • Marker

  • ✓

  • ✓

    • ✓

 

Value

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::Value

title

Str

✓

header to use for widget

data

  • expr

  • recs

    • point

    • color

    • relative

Dict

  • Str

  • Dict[]

    • Ref

    • Str

    • Marker

  • ✓

  • ✓

    • ✓

 

Graphic

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::Graphic

title

Str

✓

header to use for widget

data

  • expr

  • rec

Dict

  • Str

  • Ref

  • ✓

  • ✓

 

proto

  • target

Dict

  • Ref

 

 

Weather

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::Weather

title

Str

✓

header to use for widget

widget

Str

 

ex. weatherSmall

data

  • expr

  • rec

  • Str

  • Ref

  • ✓

  • ✓

 

Map

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::Map

title

Str

✓

header to use for widget

widget

Str

 

light, dark, ect

data

  • expr

  • proto

    • color

Dict

  • Str

  • Dict

    • Str

 

 

Table

Tag Name

Type

Optional

Description

Tag Name

Type

Optional

Description

type

Str

 

finDashboardExt::Table

title

Str

✓

header to use for widget

data

  • expr

Dict

  • Str

 

 

Table Data Type Rendering

To adjust the pagination for the table add pageLimit to the meta (ex. .addMeta({pageLimit: 25}) )

Type

render

colMeta

colMeta - kind

default

Type

render

colMeta

colMeta - kind

default

Str

if length > 50 show rest as popover

maxLength: 50

 

 

Bool

 

trueText: "On"
falseText: "Off"
trueColor: "green"
falseColor: "gray"

trueText: Str
falseText: Str
trueColor: Str
falseColor: Str

trueText: True
falseText: False
trueColor: #028f45
falseColor: #c34c46

Marker

display as tag with checkmark

color: "pink"

Str

#4e94b5

DateTime

use moment.js to format

format: "MM-YY HH"

Str

ddd MMM DD YYYY HH:mm:ss

Date

use moment.js to format

format: "MM Do"

Str

ddd MMM DD YYYY

Time

use moment.js to format

format: "HH:mm A"

Str

HH:mm:ss

Uri

render as string if https:// -> link

button: "Click Me"
link: "/pod/foo/bar"

button: "Click Me"
link: "/pod/foo/bar"

Â