com.github.gwtd3.api.core

Class Prefix

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.core.Prefix

public class Prefix
extends com.google.gwt.core.client.JavaScriptObject

A SI Prefix, as returned by D3#formatPrefix()

Example: var prefix = d3.formatPrefix(1.21e9); console.log(prefix.symbol); console.log(prefix.scale(1.21e9)); // 1.21

Author:

Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Prefix()

Method Summary

Methods

Modifier and Type	Method and Description
double	scale(double input) Convert the number to the appropriate prefixed scale.
String	symbol() Returns the prefix symbol, such as "M" for millions.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Prefix

protected Prefix()

Method Detail

symbol

public final String symbol()

Returns the prefix symbol, such as "M" for millions.

Returns:

the prefix symbol

scale

public final double scale(double input)

Convert the number to the appropriate prefixed scale.

Parameters:

input - the number to convert

Returns:

the converted number