Top  | Previous | Next

Date Range

calendars_DateRange1

Description

The date range component provides an intuitive, drag-and-drop way to select a contiguous range of time. The user is shown a timeline and can drag or stretch the selection box around on the timeline. The selected range is always a whole number of units, where the unit is determined by the current zoom level. For instance, in the screenshot the selected range is Feb 12, 2007 through Feb 20, 2007. This means from the beginning of the 12th through the end of the 20th.

 

Using this component is as simple as using the Start Date and End Date properties that the component provides. Typically, you'll include these dates in a dynamic SQL query binding that drives whatever you're using the date range for, such as a table or chart. For instance, your query binding might look like this:

 

SELECT Column1, Column2, Column3

FROM MyTable WHERE

  t_stamp >= {Root Container.Date Range.startDate} AND

  t_stamp <= {Root Container.Date Range.endDate}

 

Data Density Histogram

As an advanced optional feature, the date range can display a data density histogram inside the timeline. This is useful for historical data with gaps in it, so that the end user isn't hunting for data. (Tip: this is also great for demos, to make it easy to find historical data in a database that isn't being continously updated).

 

To use this feature, bind the Data Density dataset to a query that returns just the timestamps of the target table. These timestamps will be used to fill in the histogram behind the timeline. You can use the Outer Range Start Date and Outer Range End Date properties in your query to limit the overall return size for the query.

Properties

Appearance

Font

Font of text of this component

Scripting name

font

Data type

Font

Foreground Color

The foreground color of the component.

Scripting name

foreground

Data type

Color

Background Color

The background color of the component.

Scripting name

background

Data type

Color

Fill Background

If true, the background of the date range editor portion will be drawn. If false, it will have a transparent background.

Scripting name

fillBackground

Data type

boolean

Flags

bindable

Today Color

The color of the "Today Arrow" indicator

Scripting name

todayIndicatorColor

Data type

Color

Editor Background

The background color of the textual date range editor portion of this component.

Scripting name

editorBackground

Data type

Color

Box Fill

The fill color for the selection box.

Scripting name

boxFill

Data type

Color

Flags

expert

Selection Highlight

The focus highlight color for the selection box

Scripting name

selectionHighlight

Data type

Color

Flags

expert

Track Margin

The amount of room on either side of the slider track. May need adjusting of default font is changed.

Scripting name

trackMargin

Data type

int

Flags

expert

High Density Color

The color used to indicate high data density.

Scripting name

highDensityColor

Data type

Color

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

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Behavior

Startup Mode

Controls whether or not this date range automatically assigns itself a starting range based on the current time

Scripting name

startupMode

Data type

int

Values

0

None

1

Automatic

Startup Range

If startup mode is Automatic, this will be the starting range of time available for selection.

Scripting name

startupRange

Data type

String

Startup Selection

If startup mode is Automatic, this will be the starting selected range.

Scripting name

startupSelection

Data type

String

Max Selection

The maximum size of the selected date range

Scripting name

maxSelectionSize

Data type

String

Tick Density

This is multiplied by the width to determine the current ideal tick unit.

Scripting name

tickDensity

Data type

float

Flags

expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Enabled

If disabled, a component cannot be used.

Scripting name

componentEnabled

Data type

boolean

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

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

Start Date

The starting date of the currently selected range.

Scripting name

startDate

Data type

Date

Flags

bindable

End Date

The ending date of the currently selected range.

Scripting name

endDate

Data type

Date

Flags

bindable

Outer Range Start

The starting date of the available outer range.

Scripting name

outerRangeStartDate

Data type

Date

Flags

bindable | expert

Outer Range End

The ending date of the available outer range.

Scripting name

outerRangeEndDate

Data type

Date

Flags

bindable | expert

Data Density

A dataset that is used to calculate a histogram of data density

Scripting name

densityData

Data type

Dataset

Data Quality

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

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

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.