Class pvc.options.marks.AreaExtensionPoint

Extends MarkExtensionPoint.

Class Summary
Constructor Attributes	Constructor Name and Description
	AreaExtensionPoint The class of protovis Area extension points.

Field Summary
Field Attributes	Field Name and Description
	add Use this extension point to add a new protovis mark to another mark.
	bottom Indicates the distance between this mark's bottom side and its parent's bottom side.
	cursor The mouse cursor to show when the mouse is over.
	events The mouse events that the mark can receive.
	fillStyle The fill color.
	height The height of the area (use for vertical orientation).
	ibits Flags that affect the interactivity of the mark.
	imask Bit mask which controls the bits of ibits that should be considered.
	interpolate How to interpolate the area between values.
	left Indicates the distance between this mark's left side and its parent's left side.
	lineCap The possible ways to draw the ends of a line or line pattern.
	lineJoin The possible ways to join the segments of a line.
	lineWidth The line width.
	right Indicates the distance between this mark's right side and its parent's right side.
	strokeDasharray The possible stroke patterns.
	strokeMiterLimit The maximum ratio of the miter-join length to the line width.
	strokeStyle The line color.
	tension The tension of cardinal splines.
	top Indicates the distance between this mark's top side and its parent's top side.
	visible Indicates if a mark is visible.
	width The width of the area (use for horizontal orientation).

Class Detail

pvc.options.marks.AreaExtensionPoint

The class of protovis Area extension points.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Area.html.

Field Detail

{function} add

Use this extension point to add a new protovis mark to another mark.

If the extension point refers to a panel mark, the parent of the new mark will be that panel. Otherwise, its parent will be the parent panel of the mark of the extension point.

The following example shows how to add an image to an axis tick:

function yAxisTick(){
    return new pv.Image()
            .url('res/images/arrowYy.png')
            .lineWidth(0)
            .height(7)
            .width(5);
}

Borrowed from:: MarkExtensionPoint

{number} bottom

Indicates the distance between this mark's bottom side and its parent's bottom side.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#bottom.

Borrowed from:: MarkExtensionPoint

{string} cursor

The mouse cursor to show when the mouse is over. The value is a CSS2 cursor: http://www.w3.org/TR/CSS2/ui.html#propdef-cursor.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#cursor.

Borrowed from:: MarkExtensionPoint

{string} events

The mouse events that the mark can receive.

The possible values are: 'none', 'painted' and 'all'.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#events.

Borrowed from:: MarkExtensionPoint

{pvc.options.varia.ColorString} fillStyle

The fill color.

{number} height

The height of the area (use for vertical orientation).

{number|string} ibits

Flags that affect the interactivity of the mark.

The default value, -1 has all bits with the value "1".

Only the bits for which #imask is "1" are considered.

Bits can be combined by using a "|" character, for example: "Selectable|Hoverable"

The following are the supported bit values:

bit	description
Interactive	The mark can trigger and display interaction.
ShowsActivity	The mark's style can change based on the active scene.
ShowsSelection	The mark's style can change based on whether the datums in its scene are selected.
ShowsTooltip	The mark displays a tooltip when pointed to.
Selectable	The mark can be selected by one of the possible means. Use this to disable this mark from affecting selection, by whatever means.
SelectableByClick	The mark can be selected by clicking on it. Requires the Selectable bit as well.
SelectableByRubberband	The mark can be selected by using the rubber-band.
SelectableByFocusWindow	The mark can be selected when the focus window reveals it.
Hoverable	The mark can be hovered-over and affect its scene's active state.
Clickable	The mark can be clicked and trigger the clickAction handler.
DoubleClickable	The mark can be double-clicked and trigger the doubleClickAction handler.

Default Value:: -1

Borrowed from:: MarkExtensionPoint

{number|string} imask

Bit mask which controls the bits of ibits that should be considered.

The default value, 0 has all bits with the value "0".

See #ibits for more information.

Default Value:: 0

Borrowed from:: MarkExtensionPoint

{pvc.options.varia.LineAreaInterpolation} interpolate

How to interpolate the area between values.

{number} left

Indicates the distance between this mark's left side and its parent's left side.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#left.

Borrowed from:: MarkExtensionPoint

{pvc.options.varia.StrokeLineCap} lineCap

The possible ways to draw the ends of a line or line pattern.

Default Value:: 'butt'

{pvc.options.varia.StrokeLineJoin} lineJoin

The possible ways to join the segments of a line.

Use in combination with the property #strokeMiterLimit.

Default Value:: 'miter'

{number} lineWidth

The line width.

{number} right

Indicates the distance between this mark's right side and its parent's right side.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#right.

Borrowed from:: MarkExtensionPoint

{pvc.options.varia.StrokeDasharray} strokeDasharray

The possible stroke patterns.

{number} strokeMiterLimit

The maximum ratio of the miter-join length to the line width.

When #lineJoin is miter, and the angle between consecutive segments becomes small, the sharp angle corner — the miter — becomes long.

When a miter join exceeds the miter limit, it is automatically converted to a bevel join.

Default Value:: 8

{pvc.options.varia.ColorString} strokeStyle

The line color.

{number} tension

The tension of cardinal splines.

{number} top

Indicates the distance between this mark's top side and its parent's top side.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#top.

Borrowed from:: MarkExtensionPoint

{boolean} visible

Indicates if a mark is visible.

When a mark is not visible, all its other properties are not evaluated.

When a mark is not visible, its children are not evaluated.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Mark.html#visible.

Borrowed from:: MarkExtensionPoint

{number} width

The width of the area (use for horizontal orientation).

Types By Namespace

cdo

def

pvc

pvc.data

pvc.options

pvc.options.axes

pvc.options.charts

pvc.options.ext

pvc.options.format

pvc.options.marks

pvc.options.panels

pvc.options.plots

pvc.options.varia

pvc.options.visualRoles

pvc.visual

Class pvc.options.marks.AreaExtensionPoint