0.1.0
This routine will return an array with the specified range.
(number)
The starting number.
(number)
The length of the generated array. ie: The number of numbers to generate.
Array
:
The specified range expressed as an array.
dex.range(10, 4); // returns [ 10, 11, 12, 13 ]
This routine will return an array with the specified range.
(number)
The starting number.
(number)
The length of the generated array. ie: The number of numbers to generate.
(number)
The step increment between numbers.
Array
:
The specified range expressed as an array.
dex.range(100, 4, 10); // returns [ 100, 110, 120, 130 ]
dex.range(100, 5, -10); // returns [ 100, 90, 80, 70, 60 ]
This routine is simply a convenience function as it simply wraps underscore's implementation of a shallow copy. This method will create a shallow-copied clone of the provided plain object. Any nested objects or arrays will be copied by reference, not duplicated.
(any)
any
:
This module provides routines for dealing with arrays.
Combine two arrays into one.
Array<any>
:
A new concatentated copy of array1 and array2.
// returns [1, 2, 3, 4, 5]
dex.array.combine([1, 2], [3, 4, 5]);
Returns elements of an array where the supplied condition is matched.
(Array<any>)
The array to evaluate.
(function)
A conditional function that when true, indicates
that the index of this element should be returned.
Array<number>
:
An array consisting of the indexes of the elements
which match the supplied condition.
// returns [ 0, 1, 2, 3]
dex.array.findIndexes([1,2,3,4,5],function(e){return e<5;}));
// returns [3, 5]
dex.array.findIndexes(["a", "b", "c", "d", "e", "d"],
function(e) {return e=="d";}
Returns all possible combinations of length comboLength from the given array.
(Array<any>)
The array to be used to generate combinations.
(number)
The length of the combinations to
be generated.
:
// returns: [[1,2], [1,3], [1,4], [2,3], [2,4], [3,4]]
dex.array.getCombinations([1, 1,2,3,4], 2)
Returns all possible permutations of length maxLen from the given array.
(any)
(number)
The length of the permutations to
be generated.
(Array<any>)
The array to be used to generate permutations.
:
// returns: [[1,2],[1,3],[1,4],[2,3],[2,4],[3,4]]
dex.array.getPermutations([1,2,3,4], 2)
Inspect each element of the array and guess the overall type of the array.
(any)
string
:
A string representing the type of the array.
"date" if every element in the array is a date. "number" if every
element in the array is a number. Otherwise return "string".
Returns whether every element in an array is numeric or not.
(Array<any>)
The array to evaluate.
boolean
:
True, if every element in the array is numeric, otherwise false.
// Returns true
dex.array.isNumeric([1, 2, 3]);
// Returns false
dex.array.isNumeric(["A", 2, 3]);
Return the unique members of an array in the natural order they occur.
dex.array.naturalUnique(array) - Return an array containing the unique values within the array.
(Array<any>)
The array to evaluate.
Array<any>
:
An array of unique values within the given array.
// Returns: [ 3, 2, 1 ]
dex.array.naturalUnique([3, 2, 1, 2, 3];
Return the specified slice of an array without modifying the original array.
(Array<any>)
The array to slice.
(any)
(number)
If supplied, return at most, this number of rows
in the resulant array.
var myArray = [ 1, 2, 3, 4, 5 ];
// Returns: [ 3, 4, 5]
slice(myArray, 2);
// Returns: [ 1, 3, 5 ]
slice(myArray, [0, 2, 4]);
// returns a copy of the array:
slice(myArray);
Return the unique members of an array.
dex.array.unique(array) - Return an array containing the unique values within the array.
(Array<any>)
The array to evaluate.
Array<any>
:
An array of unique values within the given array.
// Returns: [ 1, 2, 3]
dex.array.unique([1, 1, 2, 2, 3];
This module provides methods for dealing with color.
Given a color, lighten or darken it by the requested percent.
(string)
The color to modify.
(number)
A floating point number in the range of
[
-1.0, 1.0
]
. Negative
values will lighten the color, positive values will darken it.
string
:
The lightened or darkened color in the form of #ffffff.
Given an palette or array of colors and some optional color assignmeents, create a colormap.
(object)
An optional mapping of domain values and
preset color assignments.
Function
:
Returns the colormap function.
// Assigns a colormap of red, white and blue
var usColormap = dex.color.colormap(['red', 'white', 'blue']);
// Assigns a colormap of grey, brown and yellow and reserves red for
// Republicans and blue for Democrats.
var usPartyColors = dex.color.colormap(['grey', 'brown', 'yellow'],
{ 'Republican' : 'red', 'Democrat' : 'blue' });
Given a domain of 2 or more items and a range of 2 colors, return a categorical interpolation across the two colors based upon the supplied range.
Function
:
A colormap function.
Get the named colormap with the assigned presets.
(any)
The name of the color palette to be used.
(any)
Optional user defined color presets which are
assigned via categorial domain.
Function
:
The colormap function.
This module provides various configuration routines.
This routine supports a shorthand notation allowing the user to specify deeply nested configuration options without having to deal with nested json structures.
(any)
(object)
The configuration to expand.
object
:
An object containing the expanded configuration.
The original configuration is left untouched.
{
'cell' : {
'rect' : {
'width' : 10,
'height' : 20
}
}
}
becomes easier to read when expressed as:
{
'cell.rect.width' : 10,
'cell.rect.height' : 20,
}
This routine will take one or more objects and expand each one via dex.config.expand. The objects will then be overlaid on top of each other. Objects are supplied in descending precedence; meaning that object conflicts will be resolved by taking the value from the first supplied object defining it within the method call.
object
:
A new object representing the expanded
and overlaid objects. The objects supplied in the method
call will not be modified.
Given:
var first = {
"name": "first",
"screen.width" : 800
};
var second = {
"name": "second",
"screen.width": 100,
"screen.height": 600,
"secondField": "Only in 2nd"
};
var third = {
"name": "third",
"screen.width": 333,
"screen.height": 333,
"thirdField": "Only in 3rd"
};
Calling:
var combined = dex.config.expandAndOverlay(first, second, third);
Yields a combined value of:
{
"name": "first",
"screen": {
"width": 800,
"height": 600
},
"secondField": "Only in 2nd",
"thirdField" : "Only in 3rd"
}
Return the configuration for a font after the user's customizations have been applied.
(FontSpec)
The user customizations.
Name | Description |
---|---|
options.family string
(default "sans-serif" )
|
The font family. |
options.size number
(default 14 )
|
The font size. |
options.style string
(default "normal" )
|
The font style. |
options.weight string
(default "normal" )
|
The font weight. |
options.variant string
(default "normal" )
|
The font variant. |
object
:
An object containing the font's specifications
after the user's customizations have been applied.
Construct a text specification.
(TextSpec)
The user's options which override the default
text specification.
Name | Description |
---|---|
options.font FontSpec
|
The users's font specification. |
options.x number
(default 0 )
|
The x coordinate of the text. |
options.y number
(default 0 )
|
The y coordinate of the text. |
options.textLength number
|
The SVG text length. |
options.transform string
|
The SVG transform to apply to the text. |
options.text string
|
The text. |
options.decoration string
(default none )
|
Text decoration. |
options.dx number
(default 0 )
|
An x offset to apply. |
options.dy number
(default 0 )
|
A y offset to apply. |
options.writingMode fontSpec?
|
The text writing mode. |
options.anchor fontSpec
(default start )
|
The text anchor. One of start, middle, or end. |
options.fill FillSpec
|
The text fill specification. |
options.stroke StrokeSpec
|
The text stroke specification. |
options.format string?
|
A format to apply to the text. |
options.events EventSpec
|
Any text events. |
TextSpec
:
A revised text specification after having applied
the user's modifications.
var myText = dex.config.text({ "font.size" : 32 });
This routine will dynamically configure an SVG text entity based upon the supplied configuration.
(node)
The SVG text node to be configured.
(TextSpec)
The text specification for this node.
(number)
The index of the node (if any).
node
:
The node after having the text specification applied
to it.
var textSpec = dex.config.text({ "font.size": 32, "fill.fillColor": "red" });
d3.select("some-nodes")
.call(dex.config.configureText, textSpec);
Construct a stroke specification.
(StrokeSpec)
The user's customizations to the specification.
d3text_spec
:
The stroke specification after having applied the user's
configuration.
Construct a fill specification which allow the user to override any its settings.
(d3fill_spec)
The user's customizations.
d3fill_spec
:
A fill specification which has applied the user's
customizations.
Construct a link specification which allows the user to override any of the settings.
(d3link_spec)
The users customizations.
d3link_spec
:
A link specification generated by combining the
default with the user's customizations.
Construct a rectangle specification which allows the user to override any of the settings.
(d3rect_spec)
The users customizations.
d3rect_spec
:
A rectangle specification generated by combining the
default with the user's customizations.
Construct an events specification which allows the user to override any of the settings.
(d3events_spec)
The users customizations.
d3events_spec
:
An events specification generated by combining the
default with the user's customizations.
Construct an line specification which allows the user to override any of the settings.
(d3line_spec)
The users customizations.
d3line_spec
:
A line specification generated by combining the
default with the user's customizations.
Construct an path specification which allows the user to override any of the settings.
(d3path_spec)
The users customizations.
d3path_spec
:
A path specification generated by combining the
default with the user's customizations.
Is this correct? It looks suspect to me.
(any)
(any)
(any)
(any)
any
:
Construct an point specification which allows the user to override any of the settings.
(d3point_spec)
The users customizations.
d3point_spec
:
A point specification generated by combining the
default with the user's customizations.
Construct an circle specification which allows the user to override any of the settings.
(d3circle_spec)
The users customizations.
d3circle_spec
:
A circle specification generated by combining the
default with the user's customizations.
Construct an tick specification which allows the user to override any of the settings.
(d3tick_spec)
The users customizations.
d3tick_spec
:
A tick specification generated by combining the
default with the user's customizations.
Configure the input parameters for configuring an axis. Certain defaults are imposed should the "custom" variable not specify that parameter.
(any)
The user supplied axis configuration.
d3axis_spec
:
The axis specification with
user supplied overrides applied.
Create an axis with the specified configuration.
(any)
The axis to configure.
(any)
The user specified axis configuration.
(any)
any
:
The newly configured axis.
Construct a {d3axis_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
d3scale_spec
:
The scale specification with
user supplied overrides applied.
Construct a linear {d3scale_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
d3scale_spec
:
The linear scale specification with
user supplied overrides applied.
Construct a power {d3scale_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
d3scale_spec
:
The power scale specification with
user supplied overrides applied.
Construct a sqrt {d3scale_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
d3scale_spec
:
The sqrt scale specification with
user supplied overrides applied.
Construct a log {d3scale_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
d3scale_spec
:
The log scale specification with
user supplied overrides applied.
Construct a ordinal {d3scale_spec} based on reasonable defaults with user customizations applied on top.
(any)
The user customizations.
Name | Description |
---|---|
custom.rangeRoundBands object?
|
- |
custom.rangeBands object?
|
- |
custom.rangePoints object?
|
rangePoints(interval [ , padding ] ) : Sets the output range from the specified continuous interval. The array interval contains two elements representing the minimum and maximum numeric value. This interval is subdivided into n evenly-spaced points, where n is the number of (unique) values in the input domain. The first and last point may be offset from the edge of the interval according to the specified padding, which defaults to zero. The padding is expressed as a multiple of the spacing between points. A reasonable value is 1.0, such that the first and last point will be offset from the minimum and maximum value by half the distance between points. |
custom.rangeBands object?
|
- |
d3scale_spec
:
The ordinal scale specification with
user supplied overrides applied.
This module provides routines for declaratively creating guis to configure dex components.
Create a gui for setting dimensions.
(any)
The user defined configuration.
(any)
The prefix for the target.
(any | {})
:
This module provides routines logging to the console
Log this message if the current log level is greater than or equal to dex.console.logLevel.
(any)
The log level for this message.
(any)
One or more messages to be logged. Strings will simply
use console.log while objects will use console.dir.
console
:
Write one or more DEBUG level messages.
(any)
One or more DEBUG messages to log.
(dex.console | any)
:
Write one or more NORMAL level messages.
(any)
One or more NORMAL messages to log.
(dex.console | any)
:
Write one or more WARN level messages.
(any)
One or more WARN messages to log.
(dex.console | any)
:
Write one or more FATAL level messages.
(any)
One or more FATAL messages to log.
(dex.console | any)
:
This function returns the current log level.
(any)
any
:
The current log level.
Print a stack trace to the console.
Log the message if log level is equal to or greater than the supplied log level.
(any)
(any)
(any)
module:dex/console
:
Log the message as a concatentated string to the console using NORMAL level logLeve.
module:dex/console
:
Construct a csv from the supplied header and data.
((csv | header))
header.
(data)
data.
(any)
{header: any, data: {header, data}}
:
Given a csv and a column index, return the name of the column. If a string is supplied, return the string if it is the name of a header. If an integer is supplied, return the name of the header if that header exists. This allows us to enable users to index columns via header name or by index.
(any)
The name of the column header or its index.
(any)
The csv for which we're retrieving the column name.
any
:
Null if the column index does not exist, the name
of the corresponding header otherwise.
Retrieve the column referred to by the column index. The column index can be a header name or a value column number.
(any)
The index of the column we wish to retrieve.
(any)
The csv we're retrieving the data from.
(any)
(any)
(any)
any
:
(any)
{}
:
A utility transform for dealing with some of D3's more finiky formats.
csv = { header : {C1,C2,C3}, data : [ [A,B,C], [A,B,D] ] } into: json = { "name" : rootName, "category" : category, "children" : [ "children" : [ { "name" : "A", "category" : "C1", "children" : [ { "name" : "B", "category" : "C2", "children" : [ { "name" : "C", "category" : "C3", "size" : 1 } { "name" : "D", "category" : "C3", "size" : 1 } ] } ] } ] ] }
(Object)
(any)
(any)
{}
:
(any)
(any)
{}
:
any
:
This routine will return a frames structure based on a csv and an index. It will first identify all unique values within the selected column, then sort them into an array of frame indexes. From there, it will return an array of csv where the elements contain the specified frame index at the cooresponding location. This routine supports things such as time/value filtering for things like a time or slicing dimension for various charts. IE: No need to write a motion bubble chart, simply combine a vcr-player with a regular bubble chart connected to play/rewind events and motion will follow.
(any)
(any)
The sort parameters.
{frameIndices: Array<T>, frames: Array}
:
Frame out a csv based on non-distinct permutations. Exclude the column pointed to by groupIndex from the permutations. This will be used to group and typically color the various series contained within the frames. A set of frames suitable for SPLOM might be generated via a call of getPermutationFrames(csv, 2). However, as this is written generically, it will also support higher order dimensions as well.
(any)
The length of the desired permutations.
(any)
The index of we are grouping upon.
{frameIndices: Array, frames: Array}
:
Generate frames based upon a grouping parameter, then
(any)
The length of the combinations.
(any)
The group index. This column will be present in
every combination.
(any | {frameIndices, frames})
:
Given a series of categorical indices into a csv which contains some numeric data, create a new CSV where the first column is the aggregated categorical indices and the contents are the sum of numeric columns matching the aggregated categories.
(any)
The indices to be used in summarization.
{header, data: Array}
:
(any)
any
:
(any)
({} | any)
:
This module provides routines for generating data.
Creates a matrix of random integers within the specified range.
(any)
The matrix specification. Ex:
{
rows:10, columns: 4, min: 0, max:100
}
Array
:
An array containing spec.rows number of rows. Each row consisting of
an array containing spec.columns elements. Each element is a randomly generated integer
within the range
[
spec.min, spec.max
]
Creates a matrix of random integers within the specified range.
(any)
The matrix specification. Ex:
{
rows:10, columns:4
}
Array
:
An array containing spec.rows number of rows. Each row consisting of
an array containing spec.columns elements. Each element is a randomly generated integer
within the range
[
spec.min, spec.max
]
This method will return an identity function meeting the supplied specification.
matrix
:
{@lang javascript}
// Returns: [['R1C1', 'R1C2' ], ['R2C1', 'R2C2'], ['R3C1', 'R3C2']]
identityMatrix({rows: 3, columns: 2});
Returns an identity header array.
(any)
The specification for the header array.
Name | Description |
---|---|
spec.columns any
|
The number of columns to generate. |
Array
:
Returns an array of the specified columns.
// Returns: [ 'C1', 'C2', 'C3' ]
identityHeader({ columns: 3 });
This module provides routines for dealing with geometry.
This module provides input/output routines.
This module provides routines for dealing with json.
Converts JSON and a header to a CSV file. It is used for parallel coordinate brush events where the selected brush must be published to events as a csv.
For example, given:
json = [ { A: 1, B: 3, C: 5, D: 7 }, { A: 2, B: 4, C: 6, D: 8 } ]; header = [ 'A', 'B', 'C', 'D' ];
This will return a csv where:
csv = { header: [ 'A', 'B', 'C', 'D' ], data [[ 1, 4, 5, 7 ], [ 2, 4, 6, 8 ]];
(any)
(any)
any
:
This module provides routines for dealing with matrices.
Return the specified slice of the matrix. The original matrix is not altered.
(matrix)
The matrix to be sliced.
(number?)
If supplied, the slice will consist only of the specified
number of rows.
matrix
:
Returns a matrix consisting of unique values relative to each column.
(matrix)
The matrix to evaluate.
(any)
The column or array of columns indexes to slice.
Array<Array<Object>>
:
The unique values relative to each column. In the form
of [
[
column 1 unique values
]
,
[
column 2 unique values
]
, ...]]
Returns a transposed matrix where the rows of the new matrix are transposed with it's columns.
(matrix)
The matrix to transpose.
matrix
:
The transposed matrix, leaving the original matrix untouched.
{@lang javascript}
// Returns [['R1C1', 'R2C1', 'R3C1'], ['R1C2', 'R2C2', 'R3C2' ]]
transpose([['R1C1', 'R1C2'], ['R2C1', 'R2C2], ['R3C1', 'R3C2']]);
Return a flattened version of the matrix.
(matrix)
The matrix to flatten.
Array<Object>
:
A flattened version of the matrix.
{@lang javascript}
// Define a simple matrix.
var matrix = [['r1c1', 'r1c2'], ['r2c1', 'r2c2']]
// Returns: ['r1c1', 'r1c2', 'r2c1', 'r2c2']
flatten(matrix);
Combine each column in matrix1 with each column in matrix2.
(matrix)
The first matrix to combine.
(matrix)
The second matrix to combine.
matrix
:
The combined matrix.
{@lang javascript}
var matrix1 = [['m1r1c1', 'm1r1c2'], ['m1r2c1', 'm1r2c2']]
var matrix2 = [['m2r1c1', 'm2r1c2'], ['m2r2c1', 'm2r2c2']]
// Returns: [['m1r1c1', 'm1r1c2', 'm2r1c1', 'm2r1c2'], ['m1r2c1', 'm1r2c2', 'm2r2c1', 'm2r2c2']]
var result = combine(matrix1, matrix2);
Insert a new column at position 0 within this matrix which will contain integer values starting at 1, 2, 3, ... This is useful if your dataset lacks an existing unique index.
(matrix)
The matrix to index.
matrix
:
A copy of the original matrix with the index inserted.
Return the maximum value of the specified columnNum within the supplied matrix.
(any)
The matrix to evaluate.
(any)
The column number within the matrix to evaluate.
any
:
The maximum value of the specified column within the
supplied matrix.
This module provides routines for dealing with objects.
A pretty good, but imperfect mechanism for performing a deep clone of an object.
(any)
The object to clone.
any
:
The cloned object.
Overlay the top object on top of the bottom. This method will first clone the bottom object. Then it will drop the values within the top object into the clone.
(Object)
The object who's properties will be on top.
(Object)
The object who's properties will be on bottom.
Object
:
The overlaid object where the properties in top override
properties in bottom. The return object is a clone or
copy.
(any)
(any)
(any)
(any)
any
:
This module provides various ui components.
Construct a player component.
(any)
The configuration of the player.
Player
:
This creates a SqlQuery component which provides a SQL interface into retrieving data from a SQL Lite database.
(any)
The following configuration options are available for configuring the
behavior of the SqlQuery component.
SqlQuery
:
Creates a Table component for visualizing tabular data.
(object)
A user supplied configuration object which
will override the defaults.
Table
:
{@lang javascript}
var myTable = new dex.ui.Table({
'parent' : "#MyTableContainer",
'id' : "MyTableId"
'csv' : { header : [ "X", "Y", "Z" ],
data : [[ 1, 2, 3 ], [4, 5, 6], [7, 8, 9]]}
});
Creates a Table component for visualizing tabular data.
(object)
A user supplied configuration object which
will override the defaults.
ColumnSelector
:
{@lang javascript}
var myTable = new dex.ui.Table({
'parent' : "#MyTableContainer",
'id' : "MyTableId"
'csv' : { header : [ "X", "Y", "Z" ],
data : [[ 1, 2, 3 ], [4, 5, 6], [7, 8, 9]]}
});
This module provides utility routines.
Given a d3 element, this routine will determine the parent's bounding box and annotate information related to the bounds in which this element can expand.
(any)
The d3 element we wish to size.
any
:
The annotated d3 element.
The base constructor for a dex component.
(any)
(any)
Refresh a component. This routine will take the minimal effort to refresh a component. Components with update capability (ie: the ability to take incremental change), will perform a miminimal update. Components which do not support incremental updates will perform a full render. This behavior is controlled by the "refreshType" component option which is set either to "update" or "render".
var someChart = dex.chart.SomeChart({ refreshType: 'update' }).render();
someChart.refresh(); // Calls update on refresh. ie: partial update.
var anotherChart = dex.chart.AnotherChart({ refreshType: 'render' )}.render();
// Calls render on refresh. This means that the entire chart is recreated.
anotherChart.refresh();
Get reconstruct the saved component from the saved parameters.
any
:
the reconstructed component.
Get or set a component's attribute. When called without arguments, retrieve all the attributes of that component.
(string)
The name of the attribute we are accessing.
(any)
The value of the attribute.
Component
:
The component so that this form will support
the chaining of attr calls.
// Return the chart's configuration.
var config = chart.attr();
// Return the height attribute of the chart.
var height = chart.attr("height");
// Set attribute name to value
chart.attr("name", value);
// Set param1, param2 and a nested parameter named param3
// using dot-notation.
chart.attr("param1", "value1")
.attr("param2", "value2")
.attr("nested.param3", { key: "value" };
By default, the setter form of attr (having 2 arguments) triggers an event notifying all concerned listeners that the attribute has changed. Sometimes we wish avoid the generation of this event.
(string)
The attribute name.
(any)
The attribute value.
Component
:
Returns the component being changed so that
method chaining works.
Components must define a clone function. This is a placeholder to indicate that they have not done so should it get called.
(any)
Dummy operator in this case, but in a
real clone implementation, it would contain the
user specified options for the clone. Thus, clone
can clone and modify on the fly.
Components should define a gui definition for platforms to modify their settings interactively. This provides a generic implementation consisting of common attributes for components which have not defined their interface.
(any)
User supplied gui definitions which will
take precedence over defaults.
(any)
The component's configuration target which
will be changed when this GUI is interactec with by the
user.
GuiDefinition
:
Subscribe a component to the specified events of another component.
(Component)
The source component.
(string)
The events we are interested in.
(function)
The callback to invoke when the event is received.
Events may also pass data to this callback.
handle
:
A handle which may be used to unsubscribe from
the event channel. False if something failed.
var handle = chart1.subscribe(chart2, 'select', function(event) {
// do something
});
Unsubscribe this component from the channel indicated in the handle.
(any)
(handle)
handle attained through cmp.subscribe.
Component
:
The component for method chaining support.
Publish an event to the component's subscribers.
(any)
The event to publish. An event can be any object, however,
it must define a property named "type".
Name | Description |
---|---|
event.type any
|
The type of the event we are publishing. |
A default no-op implementation of render. Subclasses should override this method with one which provides an initial rendering of their specific component. This is a great place to put one-time only initialization logic.
A default no-op implementation of update. This will update the current component relative to any new setting or data changes.
Resize the component.
component
:
Render the chart asynchronously and ensure we don't attempt to render more than 1x / second via debounce.
Update the chart asynchronously and ensure we don't attempt to update more than 1x / second via debounce.
Refresh the chart asynchronously and ensure we don't attempt to refresh more than 1x / second via debounce.
Resize the chart asynchronously and ensure we don't attempt to resize more than 1x / second via debounce.
Default implementation for chart deletion.
Delete the chart. Unregister listeners and delete it gracefully.
Save a specified attribute.
(any)
The attribute name.
(any)
The attribute value.
Component
:
Returns the component for method chaining.
Load component state from the DOM. It silently looks for the information within an attribute with id=dexjs-config descended from the HTML page body. Each chart configured is encapsulated in a div element with a chart-id attribute set to the id of that component as defined in it's config.id option. This means that if you wish to configure multiple instances of the same chart type on the same page, you must supply them with unique id's.
Component
:
Returns the component after having the loaded attributes
applied to it.
Save the user modified component state to the DOM. The information is stored in an element with selector path: "body div#dexjs-config". Under this element, individual charts are configured in a descending div element with attribute "chart-id" set to the component's config.id.
Component
:
Returns the component for method chaining.
This module provides C3 based visualization components.
This is the base constructor for C3 charts.
(any)
The chart's configuration.
C3Chart
:
This is the base constructor for a C3 Pie Chart.
(any)
The chart's configuration.
DonutChart
:
This is the base constructor for a C3 Donut Chart.
(any)
The chart's configuration.
DonutChart
:
This is the base constructor for a C3 Bar Chart.
(any)
The chart's configuration.
BarChart
:
This is the base constructor for a C3 Line Chart.
(any)
The chart's configuration.
LineChart
:
This module provides a C3 ScatterPlot
(any)
any
:
ScatterPlot
This module provides a C3 StackedArea Chart.
(any)
any
:
StackedAreaChart
This module provides a C3 StackedBar Chart.
(any)
any
:
StackedBarChart
This module provides D3 based visualization components.
This is the base constructor for a D3 BumpChart component.
(object)
The chart's configuration.
Name | Description |
---|---|
options.parent string
(default #BumpChartParent )
|
A selector pointing to the parent container to which this chart will be added. |
options.id string
(default BumpChartId )
|
The id of this chart. This enables it to be uniquely styled, even on pages with multiple charts of the same type. |
options.class string
(default BumpChartClass )
|
The class of this chart. This enables groups of similarly classed charts to be styled in a common manner. |
options.resizable boolean
(default true )
|
If true, the chart will resize itself to the size of the parent container, otherwise, it will observe any height/width limitations imposed by the options. |
options.csv csv
|
The csv data for this chart. This chart expects a CSV consisting of 3 columns of the form: Category:String, Sequence:Number, Ranking:Number. |
options.width (number | string)
(default 100% )
|
The width of the chart expressed either as a number representing the width in pixels, or as a percentage of the available parent container space. |
options.height (number | string)
(default 100% )
|
The height of the chart expressed either as a number representing the height in pixels, or as a percentage of the available parent container space. |
options.margin margin
|
The margins of this chart. Expressed as an object with properties top, bottom, left and right which represent the top, bottom, left and right margins respectively. |
options.transform string
|
The transformation to apply to the chart. ex: rotate(45), size(.5), etc... |
options.speed number
|
The time, in milliseconds between transitions or frames as the chart displays. |
options.chartLabel TextSpec
|
The text specification for chart labels. |
options.categoryLabel TextSpec
|
The text specification for categories. |
options.sequenceLabel TextSpec
|
The text specification for sequences. |
options.circle CircleGroupSpec
|
The specification for nodes represented as circles under normal and emphasized circumstances. |
options.line LineGroupSpec
|
The specification for lines under normal and emphasized circumstances. |
(ColormapName)
The name of the colormap to use for our
color scheme.
(string)
The d3 format to apply to the format of the ticks.
BumpChart
:
This is the base constructor for a D3 Chord diagram.
(any)
(object)
The chart's configuration.
Name | Description |
---|---|
options.parent string
(default #ChordParent )
|
A selector pointing to the parent container to which this chart will be added. |
options.id string
(default ChordId )
|
The id of this chart. This enables it to be uniquely styled, even on pages with multiple charts of the same type. |
options.class string
(default ChordClass )
|
The class of this chart. This enables groups of similarly classed charts to be styled in a common manner. |
options.resizable boolean
(default true )
|
If true, the chart will resize itself to the size of the parent container, otherwise, it will observe any height/width limitations imposed by the options. |
options.csv csv
|
The csv data for this chart. |
options.width (number | string)
(default 100% )
|
The width of the chart expressed either as a number representing the width in pixels, or as a percentage of the available parent container space. |
options.height (number | string)
(default 100% )
|
The height of the chart expressed either as a number representing the height in pixels, or as a percentage of the available parent container space. |
options.margin margin
|
The margins of this chart. Expressed as an object with properties top, bottom, left and right which represent the top, bottom, left and right margins respectively. |
options.transform string
|
The transformation to apply to the chart. ex: rotate(45), size(.5), etc... |
Chord
:
This is the base constructor for a D3 Clustered Force visualization.
(any)
(object)
The chart's configuration.
Name | Description |
---|---|
options.parent string
(default #ClusteredForceParent )
|
A selector pointing to the parent container to which this chart will be added. |
options.id string
(default ClusteredForceId )
|
The id of this chart. This enables it to be uniquely styled, even on pages with multiple charts of the same type. |
options.class string
(default ClusterdForceClass )
|
The class of this chart. This enables groups of similarly classed charts to be styled in a common manner. |
options.resizable boolean
(default true )
|
If true, the chart will resize itself to the size of the parent container, otherwise, it will observe any height/width limitations imposed by the options. |
options.csv csv
|
The csv data for this chart. |
options.width (number | string)
(default 100% )
|
The width of the chart expressed either as a number representing the width in pixels, or as a percentage of the available parent container space. |
options.height (number | string)
(default 100% )
|
The height of the chart expressed either as a number representing the height in pixels, or as a percentage of the available parent container space. |
options.margin margin
|
The margins of this chart. Expressed as an object with properties top, bottom, left and right which represent the top, bottom, left and right margins respectively. |
options.transform string
|
The transformation to apply to the chart. ex: rotate(45), size(.5), etc... |
ClusteredForce
:
This is the base constructor for a D3 Dendrogram visualization.
(object)
The chart's configuration.
Name | Description |
---|---|
options.parent string
(default #DendrogramParent )
|
A selector pointing to the parent container to which this chart will be added. |
options.id string
(default DendrogramId )
|
The id of this chart. This enables it to be uniquely styled, even on pages with multiple charts of the same type. |
options.class string
(default DendrogramClass )
|
The class of this chart. This enables groups of similarly classed charts to be styled in a common manner. |
options.resizable boolean
(default true )
|
If true, the chart will resize itself to the size of the parent container, otherwise, it will observe any height/width limitations imposed by the options. |
options.csv csv
|
The csv data for this chart. |
options.width (number | string)
(default 100% )
|
The width of the chart expressed either as a number representing the width in pixels, or as a percentage of the available parent container space. |
options.height (number | string)
(default 100% )
|
The height of the chart expressed either as a number representing the height in pixels, or as a percentage of the available parent container space. |
options.margin margin
|
The margins of this chart. Expressed as an object with properties top, bottom, left and right which represent the top, bottom, left and right margins respectively. |
options.transform string
|
The transformation to apply to the chart. ex: rotate(45), size(.5), etc... |
Dendrogram
:
This is the base constructor for a D3 HorizontalLegend component.
(any)
The chart's configuration.
HorizontalLegend
:
This is the base constructor for a D3 Icicle chart.
(any)
(object)
The chart's configuration.
Name | Description |
---|---|
options.parent string
(default #IcicleParent )
|
A selector pointing to the parent container to which this chart will be added. |
options.id string
(default IcicleId )
|
The id of this chart. This enables it to be uniquely styled, even on pages with multiple charts of the same type. |
options.class string
(default IcicleClass )
|
The class of this chart. This enables groups of similarly classed charts to be styled in a common manner. |
options.resizable boolean
(default true )
|
If true, the chart will resize itself to the size of the parent container, otherwise, it will observe any height/width limitations imposed by the options. |
options.csv csv
|
The csv data for this chart. |
options.width (number | string)
(default 100% )
|
The width of the chart expressed either as a number representing the width in pixels, or as a percentage of the available parent container space. |
options.height (number | string)
(default 100% )
|
The height of the chart expressed either as a number representing the height in pixels, or as a percentage of the available parent container space. |
options.margin margin
|
The margins of this chart. Expressed as an object with properties top, bottom, left and right which represent the top, bottom, left and right margins respectively. |
options.transform string
|
The transformation to apply to the chart. ex: rotate(45), size(.5), etc... |
IcicleChart
:
This is the base constructor for a D3 HorizontalLegend component.
(any)
The chart's configuration.
Legend
:
This is the base constructor for a D3 MotionBarChart component.
(any)
The chart's configuration.
MotionBarChart
:
This is the base constructor for a D3 OrbitalLayout component.
(any)
The chart's configuration.
OrbitalLayout
:
This is the base constructor for a D3 ParallelCoordinates component.
(any)
The chart's configuration.
ParallelCoordinates
:
This is the base constructor for a D3 RadarChart component.
(any)
The chart's configuration.
RadarChart
:
This is the base constructor for a D3 RadialTree component.
(any)
The chart's configuration.
RadialTree
:
This is the base constructor for a D3 Sankey component.
(any)
The chart's configuration.
Sankey
:
This is the base constructor for a D3 Sankey component.
(any)
The chart's configuration.
Sankey
:
This is the base constructor for a D3 ScatterPlot component.
(any)
The chart's configuration.
ScatterPlot
:
This is the base constructor for a D3 Sunburst component.
(any)
The chart's configuration.
Sunburst
:
This is the base constructor for a D3 Treemap component.
(any)
The chart's configuration.
Treemap
:
This is the base constructor for a D3 VerticalLegend component.
(any)
The chart's configuration.
VerticalLegend
:
This is the base constructor for a D3 TreemapBarChart component.
(any)
The chart's configuration.
TreemapBarChart
:
This is the base constructor for a D3 TopoJsonMap component.
(any)
The chart's configuration.
TopoJsonMap
:
.attr("radius", function (d) { return (dex.object.isNumeric(d.radius) ? d.radius : 1); }) .attr("cx", function (d) { return (dex.object.isNumeric(d.x) ? d.x : 0); }) .attr("cy", function (d) { return (dex.object.isNumeric(d.y) ? d.y : 0); });
This module provides d3plus based visualizations.
This is the base constructor for a D3Plus RingNetwork.
(any)
The chart's configuration.
RingNetwork
:
The base constructor for an EChart.
(any)
The EChart configuration.
EChart
:
The EChart configured to specification.
Create an ECharts HeatMap with the given specification.
(any)
The chart's configuration.
HeatMap
:
An ECharts Line Chart configured to specification.
Create an ECharts LineChart with the given specification.
(any)
The chart's configuration.
LineChart
:
An ECharts Line Chart configured to specification.
Create an ECharts LineChart with the given specification.
(any)
The chart's configuration.
ParallelCoordinates
:
An ECharts Parallel Coordinates chart configured to specification.
Create an ECharts Polar Plot with the given specification.
(any)
The chart's configuration.
PolarPlot
:
An ECharts Network configured to specification.
Create an ECharts Network with the given specification.
(any)
The chart's configuration.
Network
:
An ECharts Network configured to specification.
Create an ECharts Network with the given specification.
(any)
The chart's configuration.
Network
:
An ECharts Network configured to specification.
Create an ECharts Single Axis ScatterPlot with the given specification.
(any)
The chart's configuration.
SingleAxisScatterPlot
:
An ECharts Network configured to specification.
Create an ECharts Pie Chart with the given specification.
(any)
The chart's configuration.
PieChart
:
An ECharts Pie Chart configured to specification.
Create an ECharts SteamGraph with the given specification.
(any)
The chart's configuration.
SteamGraph
:
An ECharts Steam Graph configured to specification.
Create an ECharts Radar Chart with the given specification.
(any)
The chart's configuration.
RadarChart
:
An ECharts Network configured to specification.
Create an ECharts Tree with the given specification.
(any)
The chart's configuration.
Network
:
An ECharts Tree configured to specification.
Create an ECharts LineChart with the given specification.
(any)
The chart's configuration.
BarChart3D
:
An ECharts 3D Bar Chart configured to specification.
Create charts using WebGL based Elegans.
This is the base constructor for a Elegans ScatterPlot.
(any)
The chart's configuration.
ScatterPlot
:
This module contains components related to grids and tables of information.
This is the base constructor for a JS Grid.
(any)
The chart's configuration.
JqGrid
:
This module contains components related to producing multiples.
This is the base constructor for Gridster base multiples.
(any)
The chart's configuration.
GridsterMultiples
:
This is the base constructor for Simple HTML based multiples.
(any)
The chart's configuration.
Multiples
:
This module provides NVD3 based visualization components.
This is the base constructor for a NVD3 StackedAreaChart.
(any)
The chart's configuration.
StackedAreaChart
:
This is the base constructor for a NVD3 BubbleChart.
(any)
The chart's configuration.
BubbleChart
:
This is the base constructor for a TauChart.
(any)
The chart's configuration.
TauChart
:
This is the base constructor for a TauChart AreaChart.
(any)
The chart's configuration.
AreaChart
:
This is the base constructor for a TauChart LineChart.
(any)
The chart's configuration.
LineChart
:
This is the base constructor for a TauChart ScatterPlot.
(any)
The chart's configuration.
ScatterPlot
:
This is the base constructor for a TauChart BarChart.
(any)
The chart's configuration.
BarChart
:
This is the base constructor for a TauChart StackedBarChart.
(any)
The chart's configuration.
StackedBarChart
:
This is the base constructor for a TauChart HorizontalBarChart.
(any)
The chart's configuration.
HorizontalBarChart
:
This is the base constructor for a TauChart HorizontalStackedBarChart.
(any)
The chart's configuration.
HorizontalStackedBarChart
:
This module provides ThreeJS/WebGL based visualization components.
This is the base constructor for a WebGL ScatterPlot component.
(any)
The chart's configuration.
ScatterPlot
:
This module provides VisJS based visualizations.
This is the base constructor for a VisJS Network component.
(any)
The chart's configuration.
Network
:
This is the base constructor for a VisJS Timeline component.
(any)
The chart's configuration.
Timeline
: