Class pvc.options.marks.DotExtensionPoint

Extends MarkExtensionPoint.

Class Summary
Constructor Attributes	Constructor Name and Description
	DotExtensionPoint The class of protovis Dot extension points.

Field Summary
Field Attributes	Field Name and Description
	add Use this extension point to add a new protovis mark to another mark.
	aspectRatio The aspect ratio of the shape.
	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.
	ibits Flags that affect the interactivity of the mark.
	imask Bit mask which controls the bits of ibits that should be considered.
	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.
	lineWidth The line width.
	right Indicates the distance between this mark's right side and its parent's right side.
	shape The name of the shape that the dot assumes.
	shapeAngle The rotation angle, in radian units.
	shapeRadius The radius of the dot, in pixel units.
	shapeSize The size of the dot, in square pixel units.
	strokeDasharray The possible stroke patterns.
	strokeStyle The line color.
	top Indicates the distance between this mark's top side and its parent's top side.
	visible Indicates if a mark is visible.

Class Detail

pvc.options.marks.DotExtensionPoint

The class of protovis Dot extension points.

See the associated protovis documentation at http://mbostock.github.com/protovis/jsdoc/symbols/pv.Dot.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} aspectRatio

The aspect ratio of the shape. A positive number which is the ratio of width to height.

The actual width and height are chosen so that the shape has the same area of when it has a unit aspect ratio.

Default Value:: 1

{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|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.