x

boxPlotProperties: {
   hatWidth: hwidth

where:

hwidth

Can be a number that defines the width of the hat in pixel or a string that includes a percent symbol, enclosed in single quotation marks (') that expresses a percentage value ('0%'...'100%'). The default value is '50%'.

Note: The series and group border properties control the color and format of the hats when they are drawn as boxes. When they are not drawn as boxes, the connectorLine properties control the color and format of the hats. You can set the border width to zero to remove the hats entirely (the same as hatWidth: '0%' or hatWidth: 0).

Top of page

Example: Specifying the Box Plot Hat Width

The following request against the GGSALES data source sets the hat width to 100% of the box width:

DEFINE FILE GGSALES
DIFF = UNITS-BUDUNITS;
END
GRAPH FILE GGSALES
SUM DOLLARS NOPRINT AND COMPUTE
MIN1 = MIN.DIFF;
HAT1 = MIN1 +200;
MED1 =MDN.DIFF;
HAT2 =DIFF;
MAX2 = MAX.DIFF;
 
BY REGION 
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET LOOKGRAPH BOXPLOT
ON GRAPH SET STYLE *
*GRAPH_JS
boxPlotProperties: {
   hatWidth: '100%',    
   },
series: [
 {series: 0, color: 'lightblue', border: {width: 1, color: 'blue'}}, 
]
*END
INCLUDE=ENIADefault_combine.sty,$
ENDSTYLE
END

The output is:

Setting the hatwidth to zero (0), removes the hats, but leaves the connector lines:

boxPlotProperties: {
   hatWidth: 0},

The output is:

x

boxPlotProperties: {
   drawHatAsBox: boolean   },

where:

boolean

Valid values are:

• true, which draws box plot hats as boxes.
• false, which draws normal hats. This is the default value.

Note: The series and group border properties control the color and format of the hats when they are drawn as boxes. When they are not drawn as boxes, the connectorLine properties control the color and format of the hats.

Top of page

Example: Drawing the Box Plot Hats as Boxes

The following request against the GGSALES data source draws the hats in the box plot as boxes:

DEFINE FILE GGSALES
DIFF = UNITS-BUDUNITS;
END
GRAPH FILE GGSALES
SUM DOLLARS NOPRINT AND COMPUTE
MIN1 = MIN.DIFF;
HAT1 = MIN1 +200;
MED1 =MDN.DIFF;
HAT2 =DIFF;
MAX2 = MAX.DIFF;
BY REGION 
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET LOOKGRAPH BOXPLOT
ON GRAPH SET STYLE *
*GRAPH_JS
boxPlotProperties: {
   drawHatAsBox: true     
   },
series: [
 {series: 0, color: 'lightblue', border: {width: 1, color: 'blue'}}, 
]
*END
INCLUDE=ENIADefault_combine.sty,$
ENDSTYLE
END

The output is:

x

boxPlotProperties: {
   medianLine: {
      width: number,
      color: 'cstring',
      dash: 'dstring'
   }
},

where:

number

Is the width of the line in pixels. The default value is 1.

'cstring'

Is a color defined by a keyword or numeric specification string. The default value is 'black'.

'dstring'

Is a string that defines the dash style. The default value is '', which produces a solid line. Use a string of numbers that defines the width of a dash followed by the width of the gap between dashes (for example, dash: '1 1' draws a dotted line).

Top of page

Example: Controlling the Box Plot Median Line

The following request against the GGSALES data source generates a red median line with a width of 4 and a dash with a width of 2 and a gap of 2:

DEFINE FILE GGSALES
DIFF = UNITS-BUDUNITS;
END
GRAPH FILE GGSALES
SUM DOLLARS NOPRINT AND COMPUTE
MIN1 = MIN.DIFF;
HAT1 = MIN1 +1000;
MED1 =MDN.DIFF;
HAT2 =DIFF;
MAX2 = MAX.DIFF;
BY REGION 
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET LOOKGRAPH BOXPLOT
ON GRAPH SET STYLE *
*GRAPH_JS
boxPlotProperties: {
   medianLine: {
      width: 4,
      color: 'red',
      dash: '2 2'      }},
series: [
 {series: 0, color: 'lightblue', border: {width: 1, color: 'blue'}}, 
]
*END
INCLUDE=ENIADefault_combine.sty,$
ENDSTYLE
END

The output is:

x

boxPlotProperties: {
   connectorLine: {
      width: number,
      color: 'cstring',
      dash: 'dstring'
   }
},

where:

number

Is the width of the line in pixels. The default value is 1.

'cstring'

Is a color defined by a keyword or numeric specification string. The default value is 'black'.

'dstring'

Is a string that defines the dash style. The default value is '', which produces a solid line. Use a string of numbers that defines the width of a dash followed by the width of the gap between dashes (for example, dash: '1 1' draws a dotted line).

Top of page

Example: Controlling the Box Plot Connector Line

The following request against the GGSALES data source generates a red connector line with a width of 4 and a dash with a width of 2 and a gap of 2:

DEFINE FILE GGSALES
DIFF = UNITS-BUDUNITS;
END
GRAPH FILE GGSALES
SUM DOLLARS NOPRINT AND COMPUTE
MIN1 = MIN.DIFF;
HAT1 = MIN1 +1000;
MED1 =MDN.DIFF;
HAT2 =DIFF;
MAX2 = MAX.DIFF;
BY REGION 
ON GRAPH PCHOLD FORMAT JSCHART
ON GRAPH SET LOOKGRAPH BOXPLOT
ON GRAPH SET STYLE *
*GRAPH_JS
boxPlotProperties: {
   connectorLine: {
      width: 4,
      color: 'red',
      dash: '2 2'      }
   },
series: [
 {series: 0, color: 'lightblue', border: {width: 1, color: 'blue'}}, 
]
*END
INCLUDE=ENIADefault_combine.sty,$
ENDSTYLE
END

The output is: