@visuallyjs/browser-ui 1.0.2 → 1.1.0

package/types/charts/datasource.d.ts

@@ -3,6 +3,8 @@ import { ChartModelFilter } from "./base-chart";
 import { SeriesBasedChart } from "./series-based-chart";
 /**
  * Base definition for a chart data source.
+ * @group Charts
+ * @internal
  */
 export interface ChartDataSource {
     /**
@@ -17,6 +19,8 @@ export interface ChartDataSource {
 }
 /**
  * Implementation of data source that returns no data. Used in charts initially, before anything is loaded.
+ * @group Charts
+ * @internal
  */
 export declare class BlankDataSource implements ChartDataSource {
     load(onLoad: () => any): void;
@@ -24,6 +28,8 @@ export declare class BlankDataSource implements ChartDataSource {
 }
 /**
  * Base data source for a SeriesBasedChart.
+ * @internal
+ * @group Charts
  */
 export declare abstract class BaseSeriesBasedChartDataSource implements ChartDataSource {
     chart: SeriesBasedChart<any>;
@@ -34,6 +40,8 @@ export declare abstract class BaseSeriesBasedChartDataSource implements ChartDat
 }
 /**
  * Data source for a SeriesBasedChart that reads data from an array of objects.
+ * @group Charts
+ * @internal
  */
 export declare class DataSeriesBasedDataSource extends BaseSeriesBasedChartDataSource {
     chart: SeriesBasedChart<any>;
@@ -42,6 +50,8 @@ export declare class DataSeriesBasedDataSource extends BaseSeriesBasedChartDataS
 }
 /**
  * Data source for a SeriesBasedChart that reads data from a URL. The data returned by the URL is expected to be an array of objects.
+ * @group Charts
+ * @internal
  */
 export declare class UrlSeriesBasedDataSource extends BaseSeriesBasedChartDataSource {
     chart: SeriesBasedChart<any>;
@@ -51,6 +61,7 @@ export declare class UrlSeriesBasedDataSource extends BaseSeriesBasedChartDataSo
 }
 /**
  * Data source for a SeriesBasedChart that reads data from a VisuallyJsModel or Selection.
+ * @group Charts
  */
 export declare class ModelSeriesBasedDataSource extends BaseSeriesBasedChartDataSource {
     chart: SeriesBasedChart<any>;

package/types/charts/definitions.d.ts

@@ -54,9 +54,12 @@ export interface AxisCommon {
     lineElement?: ChartSVGElement;
     font: FontSpec;
     crosshair: boolean | CrosshairOptions;
+    labelColor: string;
+    labelColorGenerator?: (v: number, idx: number) => string;
 }
 /**
  * Common properties for value and category axes.
+ * @group Charts
  */
 export interface AxisDefinitionCommon {
     /**
@@ -87,6 +90,8 @@ export interface AxisDefinitionCommon {
      * Whether to show a crosshair for this axis. If you supply 'true', defaults will be used. Otherwise you can supply options to customise the crosshair.
      */
     crosshair?: boolean | CrosshairOptions;
+    labelColor?: string;
+    labelColorGenerator?: (v: any, idx: number) => string;
 }
 /**
  * A value axis displays a set of values. It may be in either the X or Y axis, depending on how the chart is setup. For example, in a bar chart, the value axis is on the X axis, and the category axis is on the Y axis, but for a column chart it's the other way around. Scatter and bubble charts have a value axis in both X and Y.
@@ -122,6 +127,10 @@ export interface ValueAxisDefinition extends AxisDefinitionCommon {
      * Optional formatter for all value labels.
      */
     labelFormatter?: (value: number) => string;
+    /**
+     * Optional fixed step size for the axis scale.
+     */
+    step?: number;
     /**
      * Whether or not to invert the axis. If true, the axis will run from max to min instead of min to max.
      */
@@ -143,6 +152,7 @@ export interface ValueAxis extends AxisCommon {
     domain: string;
     stackedDomain?: string;
     isPercent?: boolean;
+    step?: number;
     labelPrefix?: string;
     /**
      * Optional suffix for all value labels. Will be ignored if you provide a `labelFormatter`.

package/types/charts/domain_scale_utilities.d.ts

@@ -12,7 +12,10 @@ export type AxisDomainKey = "x" | "y" | "xStacked" | "yStacked" | "r" | (string
 export interface DomainExtent {
     min: number;
     max: number;
+    step?: number;
     stepCount?: number;
+    minLimit?: number;
+    maxLimit?: number;
 }
 /**
  * Extents by domain key.
@@ -27,6 +30,7 @@ export type DomainExtentMap = Partial<Record<AxisDomainKey, DomainExtent>>;
 export type DomainOverrideMap = Partial<Record<AxisDomainKey, {
     min?: number;
     max?: number;
+    step?: number;
 }>>;
 /**
  * Output: scales by domain.

package/types/charts/legend.d.ts

@@ -55,6 +55,8 @@ export declare const LEGEND_VERTICAL_ALIGN_MIDDLE = "middle";
 export declare const LEGEND_VERTICAL_ALIGN_BOTTOM = "bottom";
 /**
  * Options for a chart legend.
+ * @group Charts
+ * @category Legend
  */
 export interface LegendSpec {
     /**

package/types/charts/pie/pie-chart.d.ts

@@ -84,6 +84,8 @@ export interface PieChartOptions extends SeriesBasedChartOptions<RecordBasedSeri
 }
 /**
  * Defines the data point type used in a PieChart. The object that is passed to a color generator is of this type.
+ * @group Charts
+ * @category Pie Chart
  */
 export type PieChartDataPoint = {
     /**

package/types/charts/sankey/sankey.d.ts

@@ -55,6 +55,7 @@ export declare const CLASS_SANKEY_NODE = "vjs-sankey-node";
 export declare const CLASS_SANKEY_LABEL = "vjs-sankey-label";
 /**
  * Options for Sankey diagram
+ * @group Charts
  */
 export interface SankeyOptions extends Omit<BaseChartOptions, "data"> {
     /**

package/types/charts/scatter/definitions.d.ts

@@ -1,6 +1,7 @@
 import { DualValueChartOptions } from "../definitions";
 /**
  * Options for a Scatter chart
+ * @group Charts
  */
 export interface ScatterChartOptions extends DualValueChartOptions {
 }

package/types/charts/series/array-based-series.d.ts

@@ -13,6 +13,8 @@ export declare const DEFAULT_ARRAY_SERIES_ID_FIELD = "id";
  * Definition of a function that can generate labels for an array series.
  * @param index The index of the data point for which we need a label
  * @param data The data object from which the series is being populated
+ * @group Charts
+ * @category Definitions
  */
 export type ArraySeriesLabelGenerator = (index: number, data: ObjectData) => string;
 /**

package/types/charts/series/definitions.d.ts

@@ -27,6 +27,7 @@ export interface RealisedSeries {
 }
 /**
  * Options for a dual value axis chart
+ * @group Charts
  */
 export interface DualValueSeriesOptions extends ChartSeriesOptions {
     /**

package/types/charts/series/series.d.ts

@@ -5,6 +5,8 @@ import { ArrayBasedSeries } from "./array-based-series";
 import { CollationSeries } from "./collation-series";
 /**
  * Defines a function that can resolve a custom SVG marker for a specific data point.
+ * @group Charts
+ * @category Definitions
  */
 export type MarkerResolutionFunction = (point: ObjectData) => string;
 /**

package/types/charts/series-based-chart.d.ts

@@ -5,6 +5,7 @@ import { ChartSVGElement } from "./util";
 import { DataSource, ObjectData } from "../core";
 /**
  * Base options for a series based chart
+ * @group Charts
  */
 export interface SeriesBasedChartOptions<T extends ChartSeriesOptions> extends BaseChartOptions {
     /**

package/types/charts/tooltip.d.ts

@@ -4,6 +4,7 @@ import { RealisedSeries } from "./series/definitions";
 import { DualValueChartSeries } from "./series";
 /**
  * Options for a tooltip
+ * @group Charts
  */
 export interface TooltipOptions {
     /**
@@ -53,6 +54,7 @@ export interface TooltipOptions {
 export declare const CLASS_VJS_TOOLTIP = "vjs-tooltip";
 /**
  * Extension of the template renderer to handle tooltips. Only `b`, `strong`, `em` and `br` elements are supported.
+ * @internal
  */
 export declare class TooltipRenderer extends BrowserUiRecado {
     $adt: Array<AbstractEntry>;
@@ -63,6 +65,7 @@ export declare class TooltipRenderer extends BrowserUiRecado {
 }
 /**
  * Definition of the `series` object passed to a Tooltip
+ * @group Charts
  */
 export type TooltipDataSeries = {
     /**
@@ -92,6 +95,7 @@ export type TooltipDataSeries = {
 };
 /**
  * Definition of the `point` object passed to a Tooltip. Not every chart type provides every field - see the individual chart docs for discussions.
+ * @group Charts
  */
 export type TooltipDataPoint = {
     /**
@@ -124,7 +128,9 @@ export type TooltipDataPoint = {
     stackTotal?: number;
 };
 /**
- * A tooltip created for use with Charts but can be used with apps and diagrams.
+ * A tooltip created for Charts. Users of the API dont interact directly with Tooltips
+ * @group Charts
+ * @internal
  */
 export declare class Tooltip {
     private parentElement;
@@ -150,7 +156,6 @@ export declare class Tooltip {
      * @protected
      */
     protected show(position: PointXY, tooltipAnchor: PointXY, payload: ObjectData): void;
-    protected showAtPageLocation(pageLocation: PointXY, tooltipAnchor: PointXY, payload: ObjectData): void;
     hide(): void;
 }
 export declare class CategoryValueTooltip extends Tooltip {

package/types/charts/util.d.ts

@@ -29,7 +29,7 @@ export interface SteppedScale extends SteppedScaleCandidate {
  * @param candidateStep
  * @internal
  */
-export declare function _calculateSteps(min: number, max: number, candidateStep: number): SteppedScaleCandidate;
+export declare function _calculateSteps(min: number, max: number, candidateStep: number, minLimit?: number, maxLimit?: number): SteppedScaleCandidate;
 /**
  * For some given min/max, compute the ideal step size to use as a range. candidateStep is
  * the first value to try; it might be ideal, in which case we use it. But if not, we try
@@ -39,14 +39,14 @@ export declare function _calculateSteps(min: number, max: number, candidateStep:
  * @param candidateStep
  * @internal
  */
-export declare function _findIdealSteps(min: number, max: number, candidateStep: number, idealStepCount: number): SteppedScale;
+export declare function _findIdealSteps(min: number, max: number, candidateStep: number, idealStepCount: number, minLimit?: number, maxLimit?: number): SteppedScale;
 /**
  * Calculates a reasonable scale for the dataset with the given min and max.
  * @param min
  * @param max
  * @internal
  */
-export declare function $autoCalculateChartScale(min: number, max: number, idealStepCount?: number): SteppedScale;
+export declare function $autoCalculateChartScale(min: number, max: number, idealStepCount?: number, minLimit?: number, maxLimit?: number): SteppedScale;
 /**
  * Calculates a scale with the exact number of steps between min and max (inclusive). It is the call site's responsibility to ensure that the numbers all relate in such a way that the labels are reasonable.
  * @param min
@@ -55,6 +55,11 @@ export declare function $autoCalculateChartScale(min: number, max: number, ideal
  * @internal
  */
 export declare function $calculateChartScaleWithSteps(min: number, max: number, stepCount: number): SteppedScale;
+/**
+ * Calculates a scale with a fixed step between min and max.
+ * @internal
+ */
+export declare function $calculateChartScaleWithStep(min: number, max: number, step: number): SteppedScale;
 /**
  * Calculates the power of 10 corresponding to the given number, eg 625 000 gives '3'
  * @param n
@@ -140,6 +145,8 @@ export declare function createContrastLabel(text: string, x: number, y: number,
  * @param chart The chart to export.
  * @param width Optional width for the output SVG.
  * @param height Optional height for the output SVG.
+ * @group Charts
+ * @category Export
  */
 export declare function exportSVG(chart: BaseChart, width?: number, height?: number): {
     element: SVGElement;

package/types/core/autosaver.d.ts

@@ -2,7 +2,8 @@ import { ModelEvent, VisuallyJsModel } from "./toolkit";
 type ABinding = [ModelEvent, Function];
 /**
  * Options for the auto save module.
- * @group Model
+ * @group Input and Output
+ * @category Model
  */
 export interface AutoSaveOptions {
     /**

package/types/core/csv-loader.d.ts

@@ -3,6 +3,8 @@ import { ObjectData } from "./model/graph";
 export declare const CSV = "csv";
 /**
  * Options for the CsvReader.
+ * @group Input and Output
+ * @category CSV Import
  */
 export interface CsvReaderOptions {
     /**
@@ -20,7 +22,8 @@ export interface CsvReaderOptions {
 }
 /**
  * A class to read and process CSV data.
- * @group IO
+ * @group Input and Output
+ * @category CSV Import
  */
 export declare class CsvReader {
     csv: string;
@@ -53,7 +56,8 @@ export declare class CsvReader {
 }
 /**
  * Options for a source,target,value CSV parser.
- * @group IO
+ * @group Input and Output
+ * @category CSV Import
  */
 export interface SourceValueTargetCsvParserOptions {
     /**
@@ -80,5 +84,7 @@ export interface SourceValueTargetCsvParserOptions {
  * @param model
  * @param parameters Optional parameters (currently unused in this implementation).
  * @returns An object containing nodes and edges.
+ * @group Input and Output
+ * @category CSV Import
  */
 export declare const SourceValueTargetCsvParser: (csv: string, model: VisuallyJsModel, parameters?: SourceValueTargetCsvParserOptions) => void;

package/types/core/event-constants.d.ts

@@ -54,17 +54,21 @@ export declare const EVENT_DATA_APPEND_END = "dataAppendEnd";
  * Event fired alongside any other operation that results in the data being updated. This event is
  * fired often and is used by various internal classes.
  * @event
+ * @group Events
+ * @category Model
  */
 export declare const EVENT_DATA_UPDATED = "dataUpdated";
 /**
  * Fired immediately prior to the graph being cleared.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_GRAPH_CLEAR_START = "graphClearStart";
 /**
  * Fired immediately after the graph has been cleared.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_GRAPH_CLEARED = "graphCleared";
@@ -76,6 +80,7 @@ export declare const EVENT_GRAPH_CHANGED = "graphChanged";
 /**
  * Fired when a group has been updated in the model.
  * @event
+ * @group Events
  * @category Model
  * @payload GroupUpdatedParams
  */
@@ -83,6 +88,7 @@ export declare const EVENT_GROUP_UPDATED = "group:updated";
 /**
  * Fired when a node has been updated in the model.
  * @event
+ * @group Events
  * @category Model
  * @payload NodeUpdatedParams
  */
@@ -90,6 +96,7 @@ export declare const EVENT_NODE_UPDATED = "node:updated";
 /**
  * Fired when a port has been updated in the model.
  * @event
+ * @group Events
  * @category Model
  * @payload PortUpdatedParams
  */
@@ -97,6 +104,7 @@ export declare const EVENT_PORT_UPDATED = "port:updated";
 /**
  * Fired when an edge has been updated in the model.
  * @event
+ * @group Events
  * @category Model
  * @payload EdgeUpdatedParams
  */
@@ -104,6 +112,7 @@ export declare const EVENT_EDGE_UPDATED = "edge:updated";
 /**
  * Fired when an edge has been added to the model.
  * @event
+ * @group Events
  * @category Model
  * @payload EdgeAddedParams
  */
@@ -111,6 +120,7 @@ export declare const EVENT_EDGE_ADDED = "edge:added";
 /**
  * Fired when a node has been added to the model.
  * @event
+ * @group Events
  * @category Model
  * @payload NodeAddedParams
  */
@@ -118,6 +128,7 @@ export declare const EVENT_NODE_ADDED = "node:added";
 /**
  * Fired when an edge has been removed from the model.
  * @event
+ * @group Events
  * @category Model
  * @payload EdgeRemovedParams
  */
@@ -125,6 +136,7 @@ export declare const EVENT_EDGE_REMOVED = "edge:removed";
 /**
  * Fired when a node has been removed from the model.
  * @event
+ * @group Events
  * @category Model
  * @payload NodeRemovedParams
  */
@@ -132,6 +144,7 @@ export declare const EVENT_NODE_REMOVED = "node:removed";
 /**
  * Fired when a port has been added to the model.
  * @event
+ * @group Events
  * @category Model
  * @payload PortAddedParams
  */
@@ -139,6 +152,7 @@ export declare const EVENT_PORT_ADDED = "port:added";
 /**
  * Fired when a port has been removed from the model.
  * @event
+ * @group Events
  * @category Model
  * @payload PortRemovedParams
  */
@@ -146,6 +160,7 @@ export declare const EVENT_PORT_REMOVED = "port:removed";
 /**
  * Fired when the target of some edge has changed
  * @event
+ * @group Events
  * @category Model
  * @payload EdgeTargetChangedParams
  */
@@ -153,6 +168,7 @@ export declare const EVENT_EDGE_TARGET_CHANGED = "edge:target";
 /**
  * Fired when the source of some edge has changed
  * @event
+ * @group Events
  * @category Model
  * @payload EdgeSourceChangedParams
  */
@@ -160,6 +176,7 @@ export declare const EVENT_EDGE_SOURCE_CHANGED = "edge:source";
 /**
  * Fired when an object is added to a selection
  * @event
+ * @group Events
  * @category Model
  * @payload SelectionParams
  */
@@ -167,6 +184,7 @@ export declare const EVENT_SELECT = "select";
 /**
  * Fired when an object is removed from a selection
  * @event
+ * @group Events
  * @category Model
  * @payload SelectionParams
  */
@@ -174,6 +192,7 @@ export declare const EVENT_DESELECT = "deselect";
 /**
  * Fired when a selection is cleared.
  * @event
+ * @group Events
  * @category Model
  * @payload SelectionClearedParams
  */
@@ -181,41 +200,48 @@ export declare const EVENT_SELECTION_CLEARED = "selection:cleared";
 /**
  * Fired by the model when the geometry for an edge has changed
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_EDGE_GEOMETRY = "edge:geometry";
 /**
  * Fired by the UI when the user has made some edits to an edge path
  * @event
+ * @group Events
  * @category UI
  */
 export declare const EVENT_EDGE_PATH_EDITED = "edge:pathEdited";
 /**
  * Fired by the model when the type of a node has changed.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_EDGE_TYPE_CHANGED = "edge:typeChanged";
 /**
  * Fired by the model when the type of a node has changed.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_NODE_TYPE_CHANGED = "node:typeChanged";
 /**
  * Fired by the model when the type of a port has changed.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_PORT_TYPE_CHANGED = "port:typeChanged";
 /**
  * Fired by the model when the type of a group has changed.
  * @event
+ * @group Events
  * @category Model
  */
 export declare const EVENT_GROUP_TYPE_CHANGED = "group:typeChanged";
 /**
  * Fired as the user starts to drag a group
+ * @group Events
  * @category UI
  * @payload VertexMoveStartParams
  * @event
@@ -224,6 +250,7 @@ export declare const EVENT_GROUP_TYPE_CHANGED = "group:typeChanged";
 export declare const EVENT_GROUP_MOVE_START = "group:move:start";
 /**
  * Fired each time the mouse/pointer moves while a group is being dragged.
+ * @group Events
  * @category UI
  * @payload VertexMoveParams
  * @event
@@ -232,6 +259,7 @@ export declare const EVENT_GROUP_MOVE_START = "group:move:start";
 export declare const EVENT_GROUP_MOVE = "group:move";
 /**
  * Fired at the end of a group drag
+ * @group Events
  * @category UI
  * @payload VertexMoveEndParams
  * @event
@@ -257,6 +285,7 @@ export declare const EVENT_INTERNAL_GROUP_SIZE_CHANGED_UNDO = "internal:group:si
 export declare const EVENT_RENDERER_ADDED = "renderer:added";
 /**
  * Fired as the user starts to drag a node
+ * @group Events
  * @category UI
  * @payload VertexMoveStartParams
  * @event
@@ -265,6 +294,7 @@ export declare const EVENT_RENDERER_ADDED = "renderer:added";
 export declare const EVENT_NODE_MOVE_START = "node:move:start";
 /**
  * Fired each time the mouse/pointer moves while a node is being dragged.
+ * @group Events
  * @category UI
  * @payload VertexMoveParams
  * @event
@@ -273,29 +303,40 @@ export declare const EVENT_NODE_MOVE_START = "node:move:start";
 export declare const EVENT_NODE_MOVE = "node:move";
 /**
  * Fired at the end of a node drag
+ * @group Events
  * @category UI
  * @payload VertexMoveEndParams
  * @event
  * @context element-dragging
  */
 export declare const EVENT_NODE_MOVE_END = "node:move:end";
+/**
+ * Fired if a node drag is aborted
+ * @group Events
+ * @category UI
+ * @payload VertexMoveStartParams
+ * @event
+ * @context element-dragging
+ */
+export declare const EVENT_NODE_MOVE_ABORT = "node:move:abort";
 /**
  * Fired when the undo/redo manager has performed an undo or a redo.
  * @event
+ * @group Events
  * @category Model
  * @context undo-redo
  */
 export declare const EVENT_UNDOREDO_UPDATE = "undoredo:update";
 /**
  * Fired when the `undo` operation has occurred in the model
- * @group Constants
+ * @group Events
  * @category Model
  * @context undo-redo
  */
 export declare const EVENT_UNDO = "undo";
 /**
  * Fired when the `redo` operation has occurred in the model
- * @group Constants
+ * @group Events
  * @category Model
  * @context undo-redo
  */
@@ -304,5 +345,6 @@ export declare const EVENT_REDO = "redo";
  * Fired when a renderer is destroyed.
  * @event
  * @category UI
+ * @group Events
  */
 export declare const EVENT_DESTROY = "destroy";

package/types/core/geom.d.ts

@@ -79,6 +79,7 @@ export declare function rectanglesIntersect(r1: RectangleXY, r2: RectangleXY): b
  * Computes how much the two rectangles overlap, in square units.
  * @param r1
  * @param r2
+ * @internal
  */
 export declare function computeRectangleIntersection(r1: RectangleXY, r2: RectangleXY): number;
 /**

package/types/core/io.d.ts

@@ -4,8 +4,8 @@ import { PointXY, Geometry } from "./util";
 import { ObjectAnchorSpec } from "./model/anchor";
 /**
  * Options for a URL fetch.
- * @group Model
- * @category Input and Output
+ * @group Input and Output
+ * @category Model
  */
 export interface UrlFetchOptions {
     type?: string;
@@ -18,18 +18,19 @@ export interface UrlFetchOptions {
 }
 /**
  * Definition of a function that can parse JSON into a model. This is a high level interface that makes no assumptions about data format. You won't need to use this type unless you are writing your own parser.
- * @group Model
- * @category Input and Output
+ * @group Input and Output
+ * @category Model
  */
 export type Parser = (data: any, instance: VisuallyJsModel, parameters?: any) => any;
 /**
  * Definition of a function that can export the contents of a model. This is a high level interface that makes no assumptions about data format. You won't need to use this type unless you are writing your own exporter.
- * @group Model
- * @category Input and Output
+ * @group Input and Output
+ * @category Model
  */
 export type Exporter = (instance: VisuallyJsModel, parameters: any) => any;
 /**
  * The default type that represents an edge in a dataset to load or a saved dataset
+ * @group Model
  */
 export interface EdgeData {
     /**
@@ -66,15 +67,17 @@ export interface EdgeData {
 }
 /**
  * The default type that represents a node in a dataset to load or a saved dataset
+ * @group Data Model
  */
 export type NodeData = Record<string, any>;
 /**
  * The default type that represents a group in a dataset to load or a saved dataset
+ * @group Data Model
  */
 export type GroupData = Record<string, any>;
 /**
  * The default JSON format, consisting of optional lists of nodes, edges and groups.
- * @group Model
+ * @group Data Model
  * @category Input and Output
  */
 export interface VisuallyJsDefaultJSON {
@@ -93,8 +96,29 @@ export interface VisuallyJsDefaultJSON {
 }
 export declare const JSON_DATATYPE = "json";
 export declare const HIERARCHICAL_JSON_DATATYPE = "hierarchical-json";
+/**
+ * Register a parser for some given datatype
+ * @param name The name you will use to refer to the datatype.
+ * @param p Parser for the datatype
+ * @group Data Model
+ * @category Input and Output
+ */
 export declare function registerParser(name: string, p: Parser): void;
+/**
+ * Register an exporter for some given datatype
+ * @param name The name you will use to refer to the datatype.
+ * @param p Exporter for the datatype
+ * @group Data Model
+ * @category Input and Output
+ */
 export declare function registerExporter(name: string, p: Exporter): void;
+/**
+ * @internal
+ * @param type
+ * @param source
+ * @param instance
+ * @param parameters
+ */
 export declare function parse(type: string, source: any, instance: VisuallyJsModel, parameters: any): any;
 /**
  * Internal method that handles data export, by looking for an exporter registered for the given `type`.