Model Index

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


Extends MarkExtensionPoint.

Class Summary
Constructor Attributes Constructor Name and Description
 
The class of protovis Label extension points.
Field Summary
Field Attributes Field Name and Description
 
add
Use this extension point to add a new protovis mark to another mark.
 
Indicates the distance between this mark's bottom side and its parent's bottom side.
 
The mouse cursor to show when the mouse is over.
 
The mouse events that the mark can receive.
 
The font used by the label.
 
Flags that affect the interactivity of the mark.
 
Bit mask which controls the bits of ibits that should be considered.
 
Indicates the distance between this mark's left side and its parent's left side.
 
Indicates the distance between this mark's right side and its parent's right side.
 
The text to show in the label.
 
The horizontal text alignment.
 
The angle of the text, in radian units.
 
The vertical text alignment.
 
A CSS3 text decoration.
 
The vertical and horizontal distance that separates the label's anchor point from its associated visual element's anchor point (usually configurable by the pvc.options.plots.Plot#valuesAnchor option).
 
A CSS3 text shadow.
 
The text color.
 
top
Indicates the distance between this mark's top side and its parent's top side.
 
Indicates if a mark is visible.
Class Detail
pvc.options.marks.LabelExtensionPoint
The class of protovis Label extension points.

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

{string} font
The font used by the label.

See the supported font format in http://www.w3.org/TR/CSS2/fonts.html#font-shorthand


{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

{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

{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

{string} text
The text to show in the label.

{pvc.options.varia.TextAlignment} textAlign
The horizontal text alignment.

{number} textAngle
The angle of the text, in radian units.

The text angle is 0 at horizontal direction and grows clock-wise.

Default Value:
0

{pvc.options.varia.TextBaseline} textBaseline
The vertical text alignment.

{string} textDecoration
A CSS3 text decoration.

See the syntax of this string at: http://www.w3.org/TR/2012/WD-css-text-decor-3-20121113/#text-decoration.


{number} textMargin
The vertical and horizontal distance that separates the label's anchor point from its associated visual element's anchor point (usually configurable by the pvc.options.plots.Plot#valuesAnchor option).

The margin is only applied vertically if #textBaseline is not pvc.options.varia.TextBaseline#Middle. Likewise, the margin is only applied horizontally if #textAlign is not pvc.options.varia.TextAlignment#Center. Together, the previous two properties define the label's anchor point.


{string} textShadow
A CSS3 text shadow.

See the syntax of this string at: http://www.w3.org/TR/2012/WD-css-text-decor-3-20121113/#text-shadow-property.


{pvc.options.varia.ColorString} textStyle
The text color.

Note that gradients are not supported in the text style.


{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

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Dec 20 2018 15:47:43 GMT-0000 (WET)