Class pvc.options.axes.HeatGridColorAxis

Extends ColorAxis.

Class Summary
Constructor Attributes	Constructor Name and Description
	HeatGridColorAxis The options documentation class of the HeatGrid numeric color axis.

Field Summary
Field Attributes	Field Name and Description
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).
	normByCategory A separate scale is used for each category.
	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.HeatGridColorAxis

The options documentation class of the HeatGrid numeric color axis.

See ColorAxis for additional information.

Field Detail

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

{boolean} normByCategory

A separate scale is used for each category.

This property is currently only supported by the pvc.options.charts.HeatGridChart.

When this option is specified, the option domain is ignored. An automatically determined domain is used per existing category.

Default Value:: false

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