Top  | Previous | Next

Status Chart

charts_StatusChart

Description

The status chart component allows you to visualize the status of one or more discrete datapoints over a time range. The X-axis is always a timeseries axis, and the Y-axis is a category axis, with one entry per data series. The chart is populated with a single dataset, the first column of which must be a datetime column.

 

Wide vs Tall Datasets.

In Wide format, all of the columns but the first must be numeric. These "series" columns' headers will be used as the names on the y-axis. In Tall format, there should be exactly 3 columns. The first is the timestamp, the second is the series name, and the third is the value. For example:

Wide Format

Tall Format

t_stamp

Valve1

Valve2

2010-01-13 8:00:00

0

2

2010-01-13 8:02:00

0

2

2010-01-13 8:04:00

1

2

2010-01-13 8:06:00

1

1

2010-01-13 8:08:00

0

1

t_stamp

Name

Value

2010-01-13 8:00:00

Valve1

0

2010-01-13 8:00:00

Valve2

2

2010-01-13 8:02:00

Valve1

0

2010-01-13 8:02:00

Valve2

2

2010-01-13 8:04:00

Valve1

1

2010-01-13 8:04:00

Valve2

2

2010-01-13 8:06:00

Valve1

1

2010-01-13 8:06:00

Valve2

1

2010-01-13 8:08:00

Valve1

0

2010-01-13 8:08:00

Valve2

1

 

Color Mapping

Apart from getting the data into the series chart, the only other commonly configured option is the mapping of discrete values to colors. This is done in the Series Chart Customizer. Each named series can have its own mapping of colors, if desired. These mappings are stored in the expert-level dataset property Series Properties Data so they can be altered at runtime.

Properties

Appearance

Background Color

The background color of the component.

Scripting name

background

Data type

Color

Chart Title

Title of this chart.

Scripting name

chartTitle

Data type

String

Title Font

Font of the chart title.

Scripting name

titleFont

Data type

Font

Title Color

Color of the chart title.

Scripting name

titleColor

Data type

Color

Series Spacing

Affects the amount of spacing between series. Can be between 0.0 and 1.0. The series present on this chart are given equal space to display themselves. Series spacing is the percentage of that space that they use to do so.

Scripting name

seriesSpacing

Data type

double

Legend

Maps chart colors to descriptions.

Scripting name

legend

Data type

Dataset

Date Style

The style to display dates in. For international support.

Scripting name

dateStyle

Data type

int

Flags

expert

Values

0

Auto

1

MDY

2

DMY

3

YMD

Time Style

The style to display times of day. For international support.

Scripting name

timeStyle

Data type

int

Flags

expert

Values

15

Auto

16

12 HR

17

24 HR

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Flags

expert

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Data Format

Format of the incoming data. In "wide" format, the first column of the dataset needs to be a timestamp, and every subsequent column represents one series in the chart. In "tall" format, the first column is a timestamp, the second column is a series name, and the third a value.

Scripting name

dataFormat

Data type

int

Values

0

Wide

1

Tall

Series Data

Data about each series. Data can be in either "wide" or "tall" format.

Scripting name

data

Data type

Dataset

Flags

bindable

Series Properties Data

Properties for each series

Scripting name

properties

Data type

Dataset

Flags

bindable | expert

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Domain Axis

Domain Axis Label

Label on the domain axis.

Scripting name

domainAxisLabel

Data type

String

Domain Axis Font

Font used on the domain axis.

Scripting name

domainAxisFont

Data type

Font

Domain Axis Color

Color used on the domain axis.

Scripting name

domainAxisColor

Data type

Color

Domain Axis Location

Location of the domain axis.

Scripting name

domainAxisLocation

Data type

int

Values

2

Left

3

Right

Show Domain Axis

Sets whether or not the domain axis is visible

Scripting name

domainAxisVisible

Data type

boolean

Range Axis

Range Axis Label

Label on the range axis.

Scripting name

rangeAxisLabel

Data type

String

Range Axis Font

Font used on the range axis.

Scripting name

rangeAxisFont

Data type

Font

Range Axis Color

Color used on the range axis.

Scripting name

rangeAxisColor

Data type

Color

Range Axis Location

Location of the range axis.

Scripting name

rangeAxisLocation

Data type

int

Values

0

Top

1

Bottom

Range Axis Lower Margin

Lower margin of the range axis.

Scripting name

rangeAxisLowerMargin

Data type

double

Range Axis Upper Margin

Upper margin of the range axis.

Scripting name

rangeAxisUpperMargin

Data type

double

Show Range Axis

Sets whether or not the range axis is visible.

Scripting name

rangeAxisVisible

Data type

boolean

Uncategorized

Properties Loading

The number of properties currently being loaded

Scripting name

propertiesLoading

Data type

int

Flags

bindable | read-only

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

•mouse
•mouseMotion
•propertyChange

 

Scripting Functions

This component has no special scripting functions.