Class pvc.options.axes.AnyColorAxis

Extends ColorAxis.

Class Summary
Constructor Attributes	Constructor Name and Description
	AnyColorAxis The options documentation class of a color axis that can have either a discrete or numeric domain.

Field Summary
Field Attributes	Field Name and Description
	preserveMap Indicates if the color map used in the first render is to be preserved, regardless of having been explicitly specified through #map or inferred from #colors.
Discrete > Scale
	map Allows reserving colors to certain color scale keys.
Discrete > Style
	legendClickMode What happens when the user clicks a legend item (applies to color axes of discrete domain).
	legendDrawLine Forces a rule to be shown or not in the marker zone (applies to color axes of discrete domain).
	legendDrawMarker Forces a shape to be shown or not in the marker zone (applies to color axes of discrete domain).
	legendShape Forces a given shape to be used in the marker zone (applies to color axes of discrete domain).
	legendVisible Indicates if the legend items of the color axis should be visible (applies to color axes of discrete domain).
Numeric > Scale
	domain The domain values (applies to numeric domain axes).
	max The maximum color (applies to numeric domain axes).
	min The minimum color (applies to numeric domain axes).
	missing The color used for a null domain value (applies to numeric domain axes).
	scaleType The type of scale to use, in what concerns the range of the scale (applies to numeric domain axes).
	useAbs Indicates if the axis scale is applied over the absolute value of the domain values (applies to numeric domain axes).
Scale
	colors The colors of a color axis.
	unbound The color to use when an optional color role is unbound.

Method Summary
Method Attributes	Method Name and Description
Scale
	transform(color) The color transform function.

Class Detail

pvc.options.axes.AnyColorAxis

The options documentation class of a color axis that can have either a discrete or numeric domain.

See ColorAxis for additional information.

Field Detail

{boolean} preserveMap

Indicates if the color map used in the first render is to be preserved, regardless of having been explicitly specified through #map or inferred from #colors.

Default Value:: false

{map(string : pvc.options.varia.ColorString|pv.Color)} map

Allows reserving colors to certain color scale keys.

Color scale keys are the values of the color role. By default, the color role is bound to the dimensions of the series role. Color scale keys that are not mapped, receive colors taken from #colors. Colors in #colors that are also present in the color map are ignored.

Assuming the color role is bound to the grouping "territory, country", the following map would reserve the colors red and green to Canada and Portugal, respectively:

chartOptions.colorMap = {
    "NA~Canada":     "red",
    "EMEA~Portugal": "green"
};

Assumes that the default pvc.options.charts.BasicChart#dataSeparator is used.

{pvc.options.varia.LegendClickMode} legendClickMode

What happens when the user clicks a legend item (applies to color axes of discrete domain).

Note that when pvc.options.charts.Chart#hoverable is true, the legend item marker will be hoverable.

When pvc.options.charts.Chart#selectable is true, the legend item marker will be selectable, whatever the value of this property is. In that case, only the label part of the legend marker, will respect this property.

Default Value:: 'toggleVisible'

{boolean} legendDrawLine

Forces a rule to be shown or not in the marker zone (applies to color axes of discrete domain).

The default value depends on the chart type.

{boolean} legendDrawMarker

Forces a shape to be shown or not in the marker zone (applies to color axes of discrete domain).

The default value depends on the chart type.

{pvc.options.varia.DotShapeType} legendShape

Forces a given shape to be used in the marker zone (applies to color axes of discrete domain).

The default value depends on the chart type.

{boolean} legendVisible

Indicates if the legend items of the color axis should be visible (applies to color axes of discrete domain).

Default Value:: true

{list(pvc.options.varia.ColorString)} domain

The domain values (applies to numeric domain axes).

This option is ignored when option normByCategory is specified. In that case, an automatically determined domain is used per existing category.

{pvc.options.varia.ColorString|pv.Color} max

The maximum color (applies to numeric domain axes).

{pvc.options.varia.ColorString|pv.Color} min

The minimum color (applies to numeric domain axes).

{pvc.options.varia.ColorString|pv.Color} missing

The color used for a null domain value (applies to numeric domain axes).

The default value is this color.

Default Value:: 'lightgray'

{pvc.options.varia.ColorScaleType} scaleType

The type of scale to use, in what concerns the range of the scale (applies to numeric domain axes).

Default Value:: 'linear'

{boolean} useAbs

Indicates if the axis scale is applied over the absolute value of the domain values (applies to numeric domain axes).

Default Value:: false

{pvc.options.varia.ColorString|pv.Color|list(pvc.options.varia.ColorString|pv.Color)|function} colors

The colors of a color axis.

It can be a single color as documented in pvc.options.varia.ColorString or a single protovis color object (like: pv.color('red') or pv.Color.names.blueviolet).

Additionally, an array of color strings or protovis colors can be specified.

If a function is specified, it can be:

a protovis scale, like the one obtained by: pv.colors('red', 'blueviolet')
a scale factory - a function that given the domain values as arguments return a protovis color scale

The default color scheme depends on the axis domain being discrete or numeric.

For discrete domains, the default value is the protovis category10 color scheme:

value
value
value
value
value
value
value
value
value
value

For numeric domains, the default value is the color scheme:

value
value
value

Borrowed from:: ColorAxis

{pvc.options.varia.ColorString|pv.Color} unbound

The color to use when an optional color role is unbound.

When a color role is optional and was not specified, but color is still required to show visual elements, this property allows specifying the color with which all visual elements' color attributes will be based on.

The default value is the first color in #colors.

Contrast this option with AnyColorAxis#missing and HeatGridColorAxis#missing.

Borrowed from:: ColorAxis

Method Detail

{pv.Color} transform(color)

The color transform function.

Allows applying an effect to the colors that an axis outputs.

The default value is null except for color axes that are used only by one of the trend or plot2 plots, and whose colors property was not specified. In these cases, the default value is pvc.brighterColorTransform.

Context:: {null}

Arguments:
{pv.Color} color: The color to transform.

Returns:: {pv.Color} The transformed color.

Borrowed from:: ColorAxis

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.axes.AnyColorAxis