diff --git a/types/vis/index.d.ts b/types/vis/index.d.ts index dbb1d68647..ccf74b2567 100644 --- a/types/vis/index.d.ts +++ b/types/vis/index.d.ts @@ -295,8 +295,6 @@ export interface TimelineEventPropertiesResult { /** * Options that can be passed to a DataSet. - * - * @interface DataSetOptions */ export interface DataSetOptions extends DataSetQueueOptions { /** @@ -304,9 +302,6 @@ export interface DataSetOptions extends DataSetQueueOptions { * When data is fetched from a server which uses some specific field to identify items, * this field name can be specified in the DataSet using the option fieldId. * For example CouchDB uses the field "_id" to identify documents. - * - * @type {string} - * @memberOf DataSetOptions */ fieldId?: string; @@ -317,9 +312,6 @@ export interface DataSetOptions extends DataSetQueueOptions { * This is useful for example to automatically convert stringified dates coming * from a server into JavaScript Date objects. * The available data types are listed in section Data Types. - * - * @type {*} - * @memberOf DataSetOptions */ type?: any; } @@ -335,9 +327,6 @@ export interface DataSetQueueOptions { * Default value is null. * max: number - When the queue exceeds the given maximum number of entries, the queue is flushed automatically. Default value is Infinity. * Default value is Infinity. - * - * @type {(any | boolean)} - * @memberOf DataSetOptions */ queue?: any | boolean; } @@ -346,27 +335,20 @@ export class DataSet { /** * Creates an instance of DataSet. * - * @param {DataSetOptions} [options] DataSet options. - * - * @memberOf DataSet + * @param [options] DataSet options. */ constructor(options: DataSetOptions); /** * Creates an instance of DataSet. * - * @param {T[]} [data] An Array with items. - * @param {DataSetOptions} [options] DataSet options. - * - * @memberOf DataSet + * @param [data] An Array with items. + * @param [options] DataSet options. */ constructor(data?: T[], options?: DataSetOptions); /** * The number of items in the DataSet. - * - * @type {number} - * @memberOf DataSet */ length: number; @@ -374,21 +356,17 @@ export class DataSet { * Add one or multiple items to the DataSet. * Adding an item will fail when there already is an item with the same id. * - * @param {(T | T[])} data data can be a single item or an array with items. - * @param {IdType} [senderId] Optional sender id. - * @returns {IdType[]} The function returns an array with the ids of the added items. - * - * @memberOf DataSet + * @param data data can be a single item or an array with items. + * @param [senderId] Optional sender id. + * @returns The function returns an array with the ids of the added items. */ add(data: T | T[], senderId?: IdType): IdType[]; /** * Clear all data from the DataSet. * - * @param {IdType} [senderId] Optional sender id. - * @returns {IdType[]} The function returns an array with the ids of the removed items. - * - * @memberOf DataSet + * @param [senderId] Optional sender id. + * @returns The function returns an array with the ids of the removed items. */ clear(senderId?: IdType): IdType[]; @@ -396,63 +374,50 @@ export class DataSet { * Find all distinct values of a specified field. * If data items do not contain the specified field are ignored. * - * @param {string} field The search term. - * @returns {any[]} Returns an unordered array containing all distinct values. - * - * @memberOf DataSet + * @param field The search term. + * @returns Returns an unordered array containing all distinct values. */ distinct(field: string): any[]; /** * Flush queued changes. * Only available when the DataSet is configured with the option queue. - * - * @memberOf DataSet */ flush(): void; /** * Execute a callback function for every item in the dataset. * - * @param {(item: T, id: IdType) => void} callback The item callback. - * @param {DataSelectionOptions} [options] Optional options - * - * @memberOf DataSet + * @param callback The item callback. + * @param [options] Optional options */ forEach(callback: (item: T, id: IdType) => void, options?: DataSelectionOptions): void; /** * Get all items from the DataSet. * - * @param {DataSelectionOptions} [options] Optional options. - * @returns {T[]} When no item is found, null is returned when a single item was requested, + * @param [options] Optional options. + * @returns When no item is found, null is returned when a single item was requested, * and and empty Array is returned in case of multiple id's. - * - * @memberOf DataSet */ get(options?: DataSelectionOptions): T[]; /** * Get a single item from the DataSet. * - * @param {IdType} id The item id. - * @param {DataSelectionOptions} [options] - * @returns {T} When no item is found, null is returned when a single item was requested, + * @param id The item id. + * @returns When no item is found, null is returned when a single item was requested, * and and empty Array is returned in case of multiple id's. - * - * @memberOf DataSet */ get(id: IdType, options?: DataSelectionOptions): T; /** * Get multiple items from the DataSet. * - * @param {IdType[]} ids Array of item ids. - * @param {DataSelectionOptions} [options] Optional options. - * @returns {T[]} When no item is found, null is returned when a single item was requested, + * @param ids Array of item ids. + * @param [options] Optional options. + * @returns When no item is found, null is returned when a single item was requested, * and and empty Array is returned in case of multiple id's. - * - * @memberOf DataSet */ get(ids: IdType[], options?: DataSelectionOptions): T[]; @@ -461,92 +426,69 @@ export class DataSet { * In case of a DataView, this function does not return the DataSet * to which the DataView is connected. * - * @returns {DataSet} The DataSet itself. - * - * @memberOf DataSet + * @returns The DataSet itself. */ getDataSet(): DataSet; /** * Get ids of all items or of a filtered set of items. * - * @param {DataSelectionOptions} [options] - * @returns {IdType[]} ids of all items or of a filtered set of items. - * - * @memberOf DataSet + * @returns ids of all items or of a filtered set of items. */ getIds(options?: DataSelectionOptions): IdType[]; /** * Map every item in the DataSet. * - * @param {(item: T, id: IdType) => T} callback The mapping callback. - * @param {DataSelectionOptions} [options] Optional options. - * @returns {T[]} The mapped items. - * - * @memberOf DataSet + * @param callback The mapping callback. + * @param [options] Optional options. + * @returns The mapped items. */ map(callback: (item: T, id: IdType) => any, options?: DataSelectionOptions): any[]; /** * Find the item with maximum value of specified field. * - * @param {string} field - * @returns {T} Returns null if no item is found. - * - * @memberOf DataSet + * @returns Returns null if no item is found. */ max(field: string): T; /** * Find the item with minimum value of specified field. * - * @param {string} field - * @returns {T} Returns null if no item is found. - * - * @memberOf DataSet + * @returns Returns null if no item is found. */ min(field: string): T; /** * Subscribe from an event. * - * @param {string} event The event name. - * @param {((event: string, properties: any, senderId: IdType) => void)} callback + * @param event The event name. + * @param callback * a callback function which will be called each time the event occurs. - * - * @memberOf DataSet */ on(event: string, callback: (event: string, properties: any, senderId: IdType) => void): void; /** * Unsubscribe to an event. * - * @param {string} event The event name. - * @param {((event: string, properties: any, senderId: IdType) => void)} callback + * @param event The event name. + * @param callback * The exact same callback that was used when calling 'on'. - * - * @memberOf DataSet */ off(event: string, callback: (event: string, properties: any, senderId: IdType) => void): void; /** * Remove one or more items by id. * - * @param {IdType} id The item id. - * @param {IdType} [senderId] The sender id. - * @returns {IdType[]} Returns an array with the ids of the removed items. - * - * @memberOf DataSet + * @param id The item id. + * @param [senderId] The sender id. + * @returns Returns an array with the ids of the removed items. */ remove(id: IdType | IdType[], senderId?: IdType): IdType[]; /** * Set options for the DataSet. - * - * @param {DataSetQueueOptions} [options] - * - * @memberOf DataSet */ setOptions(options?: DataSetQueueOptions): void; @@ -554,11 +496,8 @@ export class DataSet { * Update one or multiple existing items. * When an item doesn't exist, it will be created. * - * @param {(T | T[])} data a single item or an array with items. - * @param {IdType} [senderId] - * @returns {IdType[]} Returns an array with the ids of the updated items. - * - * @memberOf DataSet + * @param data a single item or an array with items. + * @returns Returns an array with the ids of the updated items. */ update(data: T | T[], senderId?: IdType): IdType[]; } @@ -567,8 +506,6 @@ export class DataSet { * The DataSet contains functionality to format, filter, and sort data retrieved * via the methods get, getIds, forEach, and map. * These methods can have these options as a parameter. - * - * @interface DataSelectionOptions */ export interface DataSelectionOptions { /** @@ -577,9 +514,6 @@ export interface DataSelectionOptions { * By default, all properties of the items are emitted. * When fields is defined, only the properties whose name is specified * in fields will be included in the returned items. - * - * @type {(string[] | any)} - * @memberOf DataSelectionOptions */ fields?: string[] | any; @@ -589,9 +523,6 @@ export interface DataSelectionOptions { * When a field type is specified, this field in the items will be converted to the specified type. * This can be used for example to convert ISO strings containing a date to a JavaScript Date object, * or convert strings to numbers or vice versa. The available data types are listed in section Data Types. - * - * @type {*} - * @memberOf DataSelectionOptions */ type?: any; @@ -602,16 +533,11 @@ export interface DataSelectionOptions { * The function must return a boolean. * All items for which the filter function returns true will be emitted. * See section Data Filtering. - * - * @memberOf DataSelectionOptions */ filter?(item: T): boolean; /** * Order the items by a field name or custom sort function. - * - * @type {(string | any)} - * @memberOf DataSelectionOptions */ order?: string | any; @@ -620,9 +546,6 @@ export interface DataSelectionOptions { * Allowed values are 'Array' | 'Object'. * The default returnType is an Array. * The Object type will return a JSON object with the ID's as keys. - * - * @type {string} - * @memberOf DataSelectionOptions */ returnType?: string; } @@ -920,27 +843,19 @@ export type NetworkEvents = * The visualization is easy to use and supports custom shapes, styles, colors, sizes, images, and more. * The network visualization works smooth on any modern browser for up to a few thousand nodes and edges. * To handle a larger amount of nodes, Network has clustering support. Network uses HTML canvas for rendering. - * - * @export - * @class Network - * @implements {INetwork} */ export class Network { /** * Creates an instance of Network. * - * @param {HTMLElement} container the HTML element representing the network container - * @param {IData} data network data - * @param {IOptions} [options] optional network options - * - * @memberOf Network + * @param container the HTML element representing the network container + * @param data network data + * @param [options] optional network options */ constructor(container: HTMLElement, data: Data, options?: Options); /** * Remove the network from the DOM and remove all Hammer bindings and references. - * - * @memberOf Network */ destroy(): void; @@ -950,9 +865,7 @@ export class Network { * the network will stabilize again. * This method is also performed when first initializing the network. * - * @param {IData} data network data - * - * @memberOf Network + * @param data network data */ setData(data: Data): void; @@ -961,9 +874,7 @@ export class Network { * All available options can be found in the modules above. * Each module requires it's own container with the module name to contain its options. * - * @param {IOptions} options network options - * - * @memberOf Network + * @param options network options */ setOptions(options: Options): void; @@ -971,10 +882,8 @@ export class Network { * Set an event listener. * Depending on the type of event you get different parameters for the callback function. * - * @param {string} eventName the name of the event, f.e. 'click' - * @param {(params?: any) => void} callback the callback function that will be raised - * - * @memberOf Network + * @param eventName the name of the event, f.e. 'click' + * @param callback the callback function that will be raised */ on(eventName: NetworkEvents, callback: (params?: any) => void): void; @@ -983,10 +892,8 @@ export class Network { * The function you supply has to be the exact same as the one you used in the on function. * If no function is supplied, all listeners will be removed. * - * @param {string} eventName the name of the event, f.e. 'click' - * @param {(params?: any) => void} [callback] the exact same callback function that was used when calling 'on' - * - * @memberOf Network + * @param eventName the name of the event, f.e. 'click' + * @param [callback] the exact same callback function that was used when calling 'on' */ off(eventName: NetworkEvents, callback?: (params?: any) => void): void; @@ -995,10 +902,8 @@ export class Network { * After it has taken place, the event listener will be removed. * Depending on the type of event you get different parameters for the callback function. * - * @param {string} eventName the name of the event, f.e. 'click' - * @param {(params?: any) => void} callback the callback function that will be raised once - * - * @memberOf Network + * @param eventName the name of the event, f.e. 'click' + * @param callback the callback function that will be raised once */ once(eventName: NetworkEvents, callback: (params?: any) => void): void; @@ -1007,10 +912,8 @@ export class Network { * Input and output are in the form of {x:Number, y:Number} (IPosition interface). * The DOM values are relative to the network container. * - * @param {IPosition} position the canvas coordinates - * @returns {IPosition} the DOM coordinates - * - * @memberOf Network + * @param position the canvas coordinates + * @returns the DOM coordinates */ canvasToDOM(position: Position): Position; @@ -1019,17 +922,13 @@ export class Network { * Input and output are in the form of {x:Number,y:Number} (IPosition interface). * The DOM values are relative to the network container. * - * @param {IPosition} position the DOM coordinates - * @returns {IPosition} the canvas coordinates - * - * @memberOf Network + * @param position the DOM coordinates + * @returns the canvas coordinates */ DOMtoCanvas(position: Position): Position; /** * Redraw the network. - * - * @memberOf Network */ redraw(): void; @@ -1037,19 +936,13 @@ export class Network { * Set the size of the canvas. * This is automatically done on a window resize. * - * @param {string} width width in a common format, f.e. '100px' - * @param {string} height height in a common format, f.e. '100px' - * - * @memberOf Network + * @param width width in a common format, f.e. '100px' + * @param height height in a common format, f.e. '100px' */ setSize(width: string, height: string): void; /** * The joinCondition function is presented with all nodes. - * - * @param {IClusterOptions} [options] - * - * @memberOf Network */ cluster(options?: ClusterOptions): void; @@ -1059,10 +952,8 @@ export class Network { * All options of this object are explained below. * The joinCondition is only presented with the connected nodes. * - * @param {string} nodeId the id of the node - * @param {IClusterOptions} [options] the cluster options - * - * @memberOf Network + * @param nodeId the id of the node + * @param [options] the cluster options */ clusterByConnection(nodeId: string, options?: ClusterOptions): void; @@ -1074,19 +965,15 @@ export class Network { * For all qualifying nodes, clusterByConnection is performed on each of them. * The options object is described for clusterByConnection and does the same here. * - * @param {number} [hubsize] optional hubsize - * @param {IClusterOptions} [options] optional cluster options - * - * @memberOf Network + * @param [hubsize] optional hubsize + * @param [options] optional cluster options */ clusterByHubsize(hubsize?: number, options?: ClusterOptions): void; /** * This method will cluster all nodes with 1 edge with their respective connected node. * - * @param {IClusterOptions} [options] optional cluster options - * - * @memberOf Network + * @param [options] optional cluster options */ clusterOutliers(options?: ClusterOptions): void; @@ -1101,10 +988,8 @@ export class Network { * * network.clustering.findNode('fred') will return ['A','B','C','fred']. * - * @param {IdType} nodeId the node id. - * @returns {IdType[]} an array of nodeIds showing where the node is - * - * @memberOf Network + * @param nodeId the node id. + * @returns an array of nodeIds showing where the node is */ findNode(nodeId: IdType): IdType[]; @@ -1112,8 +997,8 @@ export class Network { * Similar to findNode in that it returns all the edge ids that were * created from the provided edge during clustering. * - * @param {IdType} baseEdgeId the base edge id - * @returns {IdType[]} an array of edgeIds + * @param baseEdgeId the base edge id + * @returns an array of edgeIds */ getClusteredEdges(baseEdgeId: IdType): IdType[]; @@ -1122,9 +1007,6 @@ export class Network { * baseEdgeId provided in data.edges ie. * After clustering the 'SelectEdge' event is fired but provides only the clustered edge. * This method can then be used to return the baseEdgeId. - * - * @param {IdType} clusteredEdgeId - * @returns {IdType} */ getBaseEdge(clusteredEdgeId: IdType): IdType; @@ -1134,9 +1016,6 @@ export class Network { * the edges between clusters are created and the previous edges are hidden, * until the cluster is opened. This method takes an edgeId (ie. a base edgeId from data.edges) * and applys the options to it and any edges that were created from it while clustering. - * - * @param {IdType} startEdgeId - * @param {IEdgeOptions} [options] */ updateEdge(startEdgeId: IdType, options?: EdgeOptions): void; @@ -1149,10 +1028,7 @@ export class Network { /** * Returns true if the node whose ID has been supplied is a cluster. * - * @param {IdType} nodeId the node id. - * @returns {boolean} - * - * @memberOf Network + * @param nodeId the node id. */ isCluster(nodeId: IdType): boolean; @@ -1160,10 +1036,7 @@ export class Network { * Returns an array of all nodeIds of the nodes that * would be released if you open the cluster. * - * @param {IdType} clusterNodeId the id of the cluster node - * @returns {IdType[]} - * - * @memberOf Network + * @param clusterNodeId the id of the cluster node */ getNodesInCluster(clusterNodeId: IdType): IdType[]; @@ -1174,10 +1047,8 @@ export class Network { * releaseFunction, which is a function that can be used to manually * position the nodes after the cluster is opened. * - * @param {IdType} nodeId the node id - * @param {IOpenClusterOptions} [options] optional open cluster options - * - * @memberOf Network + * @param nodeId the node id + * @param [options] optional open cluster options */ openCluster(nodeId: IdType, options?: OpenClusterOptions): void; @@ -1186,25 +1057,19 @@ export class Network { * and would like it to start in the same way next time, * ask for the seed using this method and put it in the layout.randomSeed option. * - * @returns {number} the current seed of the network. - * - * @memberOf Network + * @returns the current seed of the network. */ getSeed(): number; /** * Programatically enable the edit mode. * Similar effect to pressing the edit button. - * - * @memberOf Network */ enableEditMode(): void; /** * Programatically disable the edit mode. * Similar effect to pressing the close icon (small cross in the corner of the toolbar). - * - * @memberOf Network */ disableEditMode(): void; @@ -1213,40 +1078,30 @@ export class Network { * To get out of this mode, call disableEditMode(). * The callback functions defined in handlerFunctions still apply. * To use these methods without having the manipulation GUI, make sure you set enabled to false. - * - * @memberOf Network */ addNodeMode(): void; /** * Edit the selected node. * The explaination from addNodeMode applies here as well. - * - * @memberOf Network */ editNode(): void; /** * Go into addEdge mode. * The explaination from addNodeMode applies here as well. - * - * @memberOf Network */ addEdgeMode(): void; /** * Go into editEdge mode. * The explaination from addNodeMode applies here as well. - * - * @memberOf Network */ editEdgeMode(): void; /** * Delete selected. * Having edit mode or manipulation enabled is not required. - * - * @memberOf Network */ deleteSelected(): void; @@ -1256,11 +1111,6 @@ export class Network { * Alternative inputs are a String containing a nodeId or nothing. * When a String is supplied, the position of the node corresponding to the ID is returned. * When nothing is supplied, the positions of all nodes are returned. - * - * @param {string[]} nodeIds - * @returns {{[nodeId: IdType]: IPosition}} - * - * @memberOf Network */ getPositions(nodeIds?: IdType[]): { [nodeId: string]: Position }; getPositions(nodeId: IdType): Position; @@ -1278,8 +1128,6 @@ export class Network { * This method does not support clustering. * At the moment it is not possible to cache positions when using clusters since * they cannot be correctly initialized from just the positions. - * - * @memberOf Network */ storePositions(): void; @@ -1287,21 +1135,15 @@ export class Network { * You can use this to programatically move a node. * The supplied x and y positions have to be in canvas space! * - * @param {IdType} nodeId the node that will be moved - * @param {number} x new canvas space x position - * @param {number} y new canvas space y position - * - * @memberOf Network + * @param nodeId the node that will be moved + * @param x new canvas space x position + * @param y new canvas space y position */ moveNode(nodeId: IdType, x: number, y: number): void; /** * Returns a bounding box for the node including label. * - * @param {IdType} nodeId - * @returns {IBoundingBox} - * - * @memberOf Network */ getBoundingBox(nodeId: IdType): BoundingBox; @@ -1310,20 +1152,14 @@ export class Network { * If you supply an edgeId, vis will first match the id to nodes. * If no match is found, it will search in the edgelist and return an array: [fromId, toId]. * - * @param {IdType} nodeOrEdgeId a node or edge id - * @returns {(IdType[] | {fromId: IdType, toId: IdType}[])} - * - * @memberOf Network + * @param nodeOrEdgeId a node or edge id */ getConnectedNodes(nodeOrEdgeId: IdType): IdType[] | Array<{ fromId: IdType, toId: IdType }>; /** * Returns an array of edgeIds of the edges connected to this node. * - * @param {IdType} nodeId the node id - * @returns {IdType[]} - * - * @memberOf Network + * @param nodeId the node id */ getConnectedEdges(nodeId: IdType): IdType[]; @@ -1331,8 +1167,6 @@ export class Network { * Start the physics simulation. * This is normally done whenever needed and is only really useful * if you stop the simulation yourself and wish to continue it afterwards. - * - * @memberOf Network */ startSimulation(): void; @@ -1340,8 +1174,6 @@ export class Network { * This stops the physics simulation and triggers a stabilized event. * Tt can be restarted by dragging a node, * altering the dataset or calling startSimulation(). - * - * @memberOf Network */ stopSimulation(): void; @@ -1350,18 +1182,13 @@ export class Network { * All the stabilization options above are used. * You can optionally supply the number of iterations it should do. * - * @param {number} [iterations] the number of iterations it should do - * - * @memberOf Network + * @param [iterations] the number of iterations it should do */ stabilize(iterations?: number): void; /** * Returns an object with selected nodes and edges ids. * - * @returns {{ nodes: IdType[], edges: IdType[] }} - * - * @memberOf Network */ getSelection(): { nodes: IdType[], edges: IdType[] }; @@ -1369,9 +1196,6 @@ export class Network { * Returns an array of selected node ids like so: * [nodeId1, nodeId2, ..]. * - * @returns {IdType[]} - * - * @memberOf Network */ getSelectedNodes(): IdType[]; @@ -1379,9 +1203,6 @@ export class Network { * Returns an array of selected edge ids like so: * [edgeId1, edgeId2, ..]. * - * @returns {IdType[]} - * - * @memberOf Network */ getSelectedEdges(): IdType[]; @@ -1389,10 +1210,6 @@ export class Network { * Returns a nodeId or undefined. * The DOM positions are expected to be in pixels from the top left corner of the canvas. * - * @param {IPosition} position - * @returns {IdType} - * - * @memberOf Network */ getNodeAt(position: Position): IdType; @@ -1400,10 +1217,6 @@ export class Network { * Returns a edgeId or undefined. * The DOM positions are expected to be in pixels from the top left corner of the canvas. * - * @param {IPosition} position - * @returns {IdType} - * - * @memberOf Network */ getEdgeAt(position: Position): IdType; @@ -1412,10 +1225,6 @@ export class Network { * If highlightEdges is true or undefined, the neighbouring edges will also be selected. * This method unselects all other objects before selecting its own objects. Does not fire events. * - * @param {IdType[]} nodeIds - * @param {boolean} [highlightEdges] - * - * @memberOf Network */ selectNodes(nodeIds: IdType[], highlightEdges?: boolean): void; @@ -1424,9 +1233,6 @@ export class Network { * This method unselects all other objects before selecting its own objects. * Does not fire events. * - * @param {IdType[]} edgeIds - * - * @memberOf Network */ selectEdges(edgeIds: IdType[]): void; @@ -1434,18 +1240,12 @@ export class Network { * Sets the selection. * You can also pass only nodes or edges in selection object. * - * @param {{ nodes: IdType[], edges: IdType[] }} selection - * @param {ISelectionOptions} [options] - * - * @memberOf Network */ setSelection(selection: { nodes: IdType[], edges: IdType[] }, options?: SelectionOptions): void; /** * Unselect all objects. * Does not fire events. - * - * @memberOf Network */ unselectAll(): void; @@ -1453,27 +1253,21 @@ export class Network { * Returns the current scale of the network. * 1.0 is comparible to 100%, 0 is zoomed out infinitely. * - * @returns {number} the current scale of the network - * - * @memberOf Network + * @returns the current scale of the network */ getScale(): number; /** * Returns the current central focus point of the view in the form: { x: {Number}, y: {Number} } * - * @returns {IPosition} the view position; - * - * @memberOf Network + * @returns the view position; */ getViewPosition(): Position; /** * Zooms out so all nodes fit on the canvas. * - * @param {IFitOptions} [options] All options are optional for the fit method - * - * @memberOf Network + * @param [options] All options are optional for the fit method */ fit(options?: FitOptions): void; @@ -1482,26 +1276,17 @@ export class Network { * What that means is the view will lock onto that node, if it is moving, the view will also move accordingly. * If the view is dragged by the user, the focus is broken. You can supply options to customize the effect. * - * @param {IdType} nodeId - * @param {IFocusOptions} [options] - * - * @memberOf Network */ focus(nodeId: IdType, options?: FocusOptions): void; /** * You can animate or move the camera using the moveTo method. * - * @param {IMoveToOptions} options - * - * @memberOf Network */ moveTo(options: MoveToOptions): void; /** * Programatically release the focussed node. - * - * @memberOf Network */ releaseNode(): void; @@ -1509,63 +1294,41 @@ export class Network { * If you use the configurator, you can call this method to get an options object that contains * all differences from the default options caused by users interacting with the configurator. * - * @returns {*} - * - * @memberOf Network */ getOptionsFromConfigurator(): any; } /** * Options interface for focus function. - * - * @export - * @interface IFocusOptions - * @extends {IViewPortOptions} */ export interface FocusOptions extends ViewPortOptions { /** * Locked denotes whether or not the view remains locked to * the node once the zoom-in animation is finished. * Default value is true. - * - * @type {boolean} - * @memberOf IFocusOptions */ locked?: boolean; } /** * Base options interface for some viewport functions. - * - * @export - * @interface IViewPortOptions */ export interface ViewPortOptions { /** * The scale is the target zoomlevel. * Default value is 1.0. - * - * @type {number} the scale. - * @memberOf IFocusOptions */ scale?: number; /** * The offset (in DOM units) is how many pixels from the center the view is focussed. * Default value is {x:0,y:0} - * - * @type {IPosition} - * @memberOf IFocusOptions */ offset?: Position; /** * For animation you can either use a Boolean to use it with the default options or * disable it or you can define the duration (in milliseconds) and easing function manually. - * - * @type {(IAnimationOptions | boolean)} - * @memberOf IFitOptions */ animation?: AnimationOptions | boolean; } @@ -1573,33 +1336,20 @@ export interface ViewPortOptions { /** * You will have to define at least a scale, position or offset. * Otherwise, there is nothing to move to. - * - * @export - * @interface IMoveToOptions - * @extends {IViewPortOptions} */ export interface MoveToOptions extends ViewPortOptions { /** * The position (in canvas units!) is the position of the central focus point of the camera. - * - * @type {IPosition} - * @memberOf IMoveToOptions */ position?: Position; } /** * Animation options interface. - * - * @export - * @interface IAnimationOptions */ export interface AnimationOptions { /** * The duration (in milliseconds). - * - * @type {number} - * @memberOf IAnimationOptions */ duration: number; /** @@ -1609,34 +1359,22 @@ export interface AnimationOptions { * linear, easeInQuad, easeOutQuad, easeInOutQuad, easeInCubic, * easeOutCubic, easeInOutCubic, easeInQuart, easeOutQuart, easeInOutQuart, * easeInQuint, easeOutQuint, easeInOutQuint. - * - * @type {string} - * @memberOf IAnimationOptions */ easingFunction: string; } /** * Optional options for the fit method. - * - * @export - * @interface IFitOptions */ export interface FitOptions { /** * The nodes can be used to zoom to fit only specific nodes in the view. - * - * @type {string[]} - * @memberOf IFitOptions */ nodes?: string[]; /** * For animation you can either use a Boolean to use it with the default options or * disable it or you can define the duration (in milliseconds) and easing function manually. - * - * @type {(IAnimationOptions | boolean)} - * @memberOf IFitOptions */ animation: AnimationOptions | boolean; } @@ -1648,9 +1386,6 @@ export interface SelectionOptions { /** * These values are in canvas space. - * - * @export - * @interface IBoundingBox */ export interface BoundingBox { top: number; @@ -1661,9 +1396,6 @@ export interface BoundingBox { /** * Cluster methods options interface. - * - * @export - * @interface IClusterOptions */ export interface ClusterOptions { /** @@ -1672,8 +1404,6 @@ export interface ClusterOptions { * and calls this function with their data as argument. If this function returns true, * this node will be added to the cluster. You have access to all options (including the default) * as well as any custom fields you may have added to the node to determine whether or not to include it in the cluster. - * - * @memberOf IClusterOptions */ joinCondition?(nodeOptions: any): boolean; @@ -1683,9 +1413,6 @@ export interface ClusterOptions { * supplied by you (clusterNodeProperties), all contained nodes and all contained edges. * You can use this to update the properties of the cluster based on which items it contains. * The function should return the properties to create the cluster node. - * - * @type {(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[])} - * @memberOf IClusterOptions */ processProperties?(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[]): any; @@ -1696,9 +1423,6 @@ export interface ClusterOptions { * This allows you to style your cluster node any way you want. * This is also the style object that is provided in the processProperties function for fine tuning. * If undefined, default node options will be used. - * - * @type {INodeOptions} - * @memberOf IClusterOptions */ clusterNodeProperties?: NodeOptions; @@ -1709,18 +1433,12 @@ export interface ClusterOptions { * Using this, you can style the edges connecting to the cluster any way you want. * If none are provided, the options from the edges that are replaced are used. * If undefined, default edge options will be used. - * - * @type {IEdgeOptions} - * @memberOf IClusterOptions */ clusterEdgeProperties?: EdgeOptions; } /** * Options for the openCluster function of Network. - * - * @export - * @interface IOpenClusterOptions */ export interface OpenClusterOptions { /** @@ -1734,8 +1452,6 @@ export interface OpenClusterOptions { * For all nodeIds not listed in this returned object, * we will position them at the location of the cluster. * This is also the default behaviour when no releaseFunction is defined. - * - * @memberOf IOpenClusterOptions */ releaseFunction( clusterPosition: Position,