Visual Mining Chart Definition Language Documentation

Dial Chart

The dialchart is based on a circle that has 0 degrees as North.
Positive angles go clockwise and negative angles counterclockwise.
When you specify angles, you can use both positive and negative values.
For example, a dial's start angle could be –90 and its stop angle 90.

Each DialChart can have multiple dials. Each dial can have multiple sectors and hands.
The dial's tics and the dial's sectors can have labels. Furthermore, all sectors and hands
can have Active Labels. You can set hands and sectors to enable dragging by users.
Enabling dragging results in active modification of the sector or hand value.

Dials

Dials = (name, startAngle, stopAngle, radiusPercentage, NONE|INSIDE|OUTSIDE), ...;

name

The name of the Dial. Must be unique among all dials.

startAngle

The angle that the dial starts from. The dial sweeps in a clockwise direction.

stopAngle

The angle at which the dial stops.

radiusPercentage

The percentage of the available space the dial should use.

NONE|INSIDE|OUTSIDE

The position of the tics. NONE is for no visible tics. INSIDE is for tics inside of the dial. OUTSIDE is for tics outside of the dial.

DialOuterBorder

DialOuterBorder = (color1, color2, width);

Specifies the background color behind the Dial chart and inside a beveled border. If DialOuterBorder is specified and DialOuterFillPattern is NOT specified, DialOuterFillPattern defaults to a GRADIENTVERTICAL using color1 and color2 from DialOuterBorder.

color1	The color of upper left edge of border dial.
color2	The color of lower right edge of border dial.
width	The width of the border. -1 is default and chooses a width based on size of chart

DialTics

DialTics = (name, color, width, percentOfRadius), ...;

name	The name of the dial.
color	The color of the tics.
width	The width of the tics.
percentOfRadius	The length of the tics as a percentage of the dial's radius.

DialTicLabelStyles

DialTicLabelStyles = (name, ON|OFF, labelPos, color, font,
      size, angle), ...;

name

The name of the dial.

ON|OFF

Turn the tic Labels on and off.

labelPos

Defines the position of a tic label relative to the width of the dial. A value of 1.1 will place each label just outside the dial face, while a value of 0.6 will place each label inside of the dial border.

color

The font color.

font

The font name.

size

The font size.

angle

The angle to rotate the font. Allowable values are 0, 90, 180, and 270.

DialTicLabels

DialTicLabels = (name, label1, label2, ..., labelN), ...;

name	The name of the dial.
label1 – labelN	The tic labels 1 - N. If there are more labels than tics, only the labels that correspond to tics will be shown. If there are less labels than tics, all labels will be shown.

DialScale

DialScale = (name, minimum, maximum, step), ...;

name	The name of the dial.
minimum	The minimum value of the dial.
maximum	The maximum value of the dial.
step	The step size of the dial. The DialScale determines tic placement along the dial face.

DialSize

    DialSize = (minWidth, minHeight, maxWidth, maxHeight);

minWidth	The minimum width at which the dial should be drawn.
minHeight	The minimum height at which the dial should be drawn.
maxWidth	The maximum width at which the dial should be drawn.
maxHeight	The maximum height at which the dial should be drawn.

DialSquare

    DialSquare = mode;

mode	drawing mode. Legal values are ON and OFF

DialBorders

DialBorders = (name, type, thickness, color,
    NONE|CENTER|ENDTOEND), ...;

name

The name of the dial.

type

The line type.

thickness

The line thickness.

color

The line color.

NONE|CENTER|ENDTOEND

The border polygon behavior. NONE causes the border not to connect the ends. CENTER causes the dial to include the center of the dial in its border. ENDTOEND causes the dial to only include its points in the border.

DialFills

DialFills = (name, color, NONE|CENTER|ENDTOEND), ...;

name	The name of the dial.
color	The fill color.
NONE\|CENTER\|ENDTOEND	The fill polygon behavior. NONE does no fill. CENTER causes the dial to include the center of the dial in its fill. ENDTOEND causes the dial to only include its points in the fill.

DialActiveLabels

DialActiveLabels = (name, label, url, target), ...;

name	The name of the dial.
label	The string to be used for the label.
url	The URL to be used when the active label is activated.
target	The target for the URL.

DialDelete

DialDelete = (name|ALL), ...;

name	The name of the dial to delete or ALL for all dials.

DialClip

DialClip = clipType;

DialClip specifies quadrant(s) of the Dial Chart to be displayed using the entire graph space. For instance, specifying TOP will cause the dial to use the entire graph space to display the top-half of the dial. Specifying BOTTOMRIGHT will cause the dial to use the entire graph space to display only the bottom-right quadrant of the dial. The default is NONE which causes the entire dial to be displayed.

TOPLEFT	TOP	TOPRIGHT
LEFT	NONE	RIGHT
BOTTOMLEFT	BOTTOM	BOTTOMRIGHT

DialFormats

DialFormats = (name,FLOAT|INTEGER|DECIMAL,formatExpression),...;

name

The name of the dial.

FLOAT|INTEGER|DECIMAL

The format type.

formatExpression

The format expression. If the format type is INTEGER or FLOAT, the input data value is expected to be of type integer or float and will be parsed as such (if string conversion is necessary). The format itself is a C-language style sprintf format. Some examples:
Data Type Format Output 1000 INTEGER %d 1000 1000 INTEGER $,%d $1,000 1000 INTEGER %d% 1000% 1000 FLOAT %f 1000.0 1000 FLOAT %.2f 1000.00 1000 FLOAT $,.2f $1,000.00
If the format type is DECIMAL, the format syntax is consistent with those defined in the Java DecimalFormat spec.

DialHandAnimationStyle

	DialHandAnimationStyle = GROW | FADE | NONE;

Specifies how the dial hands initially appear in a dial chart. This parameter is only valid in SVG or SVGWeb output formats.

   example: DialHandAnimationStyle = GROW;

GROW
The dial hands rise from zero to their actual values.

FADE The dial hands fade in.

NONE The dial hands are immediately visible.

DialSectorAnimationStyle

	DialSectorAnimationStyle = GROW | FADE | NONE;

Specifies how the sectors initially appear in a dial chart. This parameter is only valid in SVG or SVGWeb output formats.

   example: DialSectorAnimationStyle = GROW;

GROW
The dial sectors rise from zero to their actual values.

FADE The dial sectors fade in.

NONE The dial sectors are immediately visible.

Sectors

Sectors = (name, color, dialName, outerRadius, innerRadius, sectorLabel), ...;

name	The name of the sector. Must be unique among all sectors.
color	The fill color of the sector.
dialName	The name of the dial of which the sector is a part.
outerRadius	The outer radius of the sector as a percentage of the dial's radius.
innerRadius	The inner radius of the sector as a percentage of the dial's radius.
sectorLabel	The label to be displayed for the sector.

SectorData

SectorData = (name, startValue, stopValue), ...;

name	The name of the sector.
startValue	The value, relative to the dial's range, that the sector starts from.
stopValue	The value, relative to the dial's range, that the sector stops at.

SectorLabels

SectorLabels = (name, ON|OFF, labelPos, color, font, size,angle), ...;

name

The name of the sector.

ON|OFF

Turn the Sector Labels on and off.

labelPos

Defines the position of a sector label relative to the radius of the dial. A value of 1.1 will place each label just outside the dial.

color

The font color.

font

The font name.

size

The font size.

angle

The angle to rotate the font. Allowable values are 0, 90, 180, and 270.

SectorBorders

SectorBorders = (name, type, thickness, color), ...;

name	The name of the sector.
type	The line type.
thickness	The line thickness.
color	The line color.

SectorColors

SectorColors = (name,  color), ...;

name	The name of the sector.
color	The color of the sector.

SectorActiveLabels

SectorActiveLabels = (name, label, url, target), ...;

name	The name of the sector.
label	The string to be used for the label.
url	The URL to be used when the active label is activated.
target	The target for the URL.

SectorDelete

SectorDelete = (name|ALL), ...;

name	The name of the sector to delete or ALL for all sectors.

SectorDrag

SectorDrag = "ON"|"OFF";

"ON"|"OFF"

Turns the dragging of sectors on or off.

SectorEdgeHighlights


	SectorEdgeHighlights = (start,stop,gap,size), ...;

The SectorEdgeHighlights parameter provides a visual pattern fill in a Dial's sectors which accents the sector edges. It overlays a ring (annulus) fill pattern over the existing fill patterns in a specified zone along the interior edge of the sector. The gap between the sides of the sector and the fill pattern being applied can be modified. The element Start sets the beginning color of the gradient, associated with the outside edge; the element Stop sets the end color of the gradient, associated with the interior of the sector where the color blends to transparency. Color values are interpolated between the two. The element Size specifies the width of the highlight. The element Gap specifies the size of the gap between the edge of the highlight and the edge of the sector. When the value for Gap is specified as a whole number, it sets the distance between the edge of the highlight and the edge of the button in pixels. When set to a fractional number between 0 and 1, it sets the gap to a percentage of the radius of the center button. Percentage values are written using a decimal point (e.g. "0.05" and "0.50" represent 5% and 50%, respectively). When using a fractional value, enclose the tuple element in double-quotes to "escape" the decimal points.

   example: SectorEdgeHighlights = (blue_25,white_75,1,25);

Hands

Hands = (name, tipColor, shaftColor, dialName, handLabel), ...;

name	The name of the Hand. Must be unique among all hands.
tipColor	The color of the tip of the hand.
shaftColor	The color of the shaft of the hand.
dialName	The name of the dial of which the hand is a part.
handLabel	The label to be displayed for the hand.

HandData

HandData = (name, value, length), ...;

name	The name of the hand.
value	The value of the hand relative to the dial's range.
length	The length of the hand as a percentage of the dial's radius.

HandLabels

HandLabels = (name, ON|OFF, labelPos, color, font, size, angle,justification), ...;

name

The name of the hand.

ON|OFF

Turn the Hand Labels on and off.

labelPos

Defines the position of a hand label relative to the radius of the dial. A value of 1.1 will place each label just outside the dial.

color

The font color.

font

The font name.

size

The font size.

angle

The angle to rotate the font. Allowable values are 0, 90, 180, and 270.

justification

The text justification of multiline labels. Allowable values are LEFT, CENTER and RIGHT.

HandStyles

HandStyles = (name, SHARP|ROUND|BLOCK|LINE|NONE, tipWidth, shaftWidth), ...;

name

The name of the hand.

SHARP|ROUND|BLOCK|LINE|NONE

The style of the tip of the hand. NONE causes the hand not to be drawn. ROUND makes a circular tip. BLOCK makes a triangular tip. SHARP makes a triangular tip that has sharper corners than BLOCK. LINE makes a line-drawn head.

tipWidth

The width of the hand tip.

shaftWidth

The width of the hand shaft.

HandActiveLabels

HandActiveLabels = (name, label, url, target), ...;

name	The name of the hand.
label	The string to be used for the label.
url	The URL to be used when the active label is activated.
target	The target for the URL.

HandBorders

      HandBorders = (Hand Name, lineType, lineWidth, lineColor),...;

This parameter specifies the line style to be used for the border of each hand in the dial. The following attribute values are supported:

lineType

SOLID (default), DOTTED, DASHED, DOTDASH

lineWidth The width of the line in pixels. Default width is 1.

lineColor The color of the line. Default color is black.

HandButtonBorder

      HandButtonBorder = (lineType, lineWidth, lineColor);

This parameter specifies the line style to be used for the button at the center of the dial. The following attribute values are supported:

lineType

SOLID (default), DOTTED, DASHED, DOTDASH

lineWidth The width of the line in pixels. Default width is 1.

lineColor The color of the line. Default color is black.

HandButtonEdgeHighlights


	HandButtonEdgeHighlights = (start,stop,gap,size), ...;

The HandButtonEdgeHighlights parameter provides a visual pattern fill in a Dial's center button which accents the center button border. It overlays a ring (annulus) fill pattern over the existing fill patterns in a specified zone along the interior edge of the center button. The gap between the sides of the center button and the fill pattern being applied can be modified. The element Start sets the beginning color of the gradient, associated with the outside edge; the element Stop sets the end color of the gradient, associated with the interior of the center button where the color blends to transparency. Color values are interpolated between the two. The element Size specifies the width of the highlight. The element Gap specifies the size of the gap between the edge of the highlight and the edge of the center button. When the value for Gap is specified as a whole number, it sets the distance between the edge of the highlight and the edge of the button in pixels. When set to a fractional number between 0 and 1, it sets the gap to a percentage of the radius of the center button. Percentage values are written using a decimal point (e.g. "0.05" and "0.50" represent 5% and 50%, respectively). When using a fractional value, enclose the tuple element in double-quotes to "escape" the decimal points.

   example: HandButtonEdgeHighlights = (blue_25,white_75,1,25);

HandDelete

HandDelete = (name|ALL), ...;

name	The name of the hand to delete or ALL for all hands.

HandDrag

HandDrag = "ON"|"OFF";

"ON"|"OFF"

Turns the dragging of hands on or off.

HandDropShadow

	HandDropShadow = (color,offsetx,offsety,size);

HandDropShadow places a shadow on the hands of the dial chart. The color, orientation, and size of the shadow can be defined. The tuple element color sets the color of the shadow. That color value is interpolated to complete transparency as it reaches the end of the shadow's blur area. Offsetx and offsety define the center point of the shadow; offsetx sets the x-axis offset from the chart's center-point; offsety sets the y-axis offset. When an offset attribute is set to a whole number value, the position of the drop shadow is offset from the chart's center point by the number of pixels set by that whole number. When an offset is set to a fractional value (between 0 and 1), the value is interpreted as a percentage of the width of the object casting the shadow (the dial hands). The center of the drop shadow is repositioned based upon the values or percentages set for offsetx and offsety. Offset attribute values may be positive or negative. Size sets the size of the blur area, the region beyond the actual drop shadow shape where the shadow is extended and blurred into transparency. The size of this blurred region is controlled by the size attribute. The blurred region becomes larger and more diffuse as the value of size is increased. When size is set to a whole number value, the size of the blurred area is defined in pixels. When size is set to a fractional value (between 0 and 1), the value is interpreted as a percentage of the width of the object casting the shadow. When using a fractional value, enclose the value in double-quotes to "escape" the decimal point.

 HandDropShadow = (black, "-.05", "-0.05", 55);

© 2015 Visual Mining, a division of Tervela, Inc. All rights reserved. Visual Mining and NetCharts Pro are trademarks of Visual Mining. Other names used herein may be trademarks of their respective owners.