diff --git a/packages/core/src/editor/Editor.ts b/packages/core/src/editor/Editor.ts
index d2b6d52eec..3dbf3e5159 100644
--- a/packages/core/src/editor/Editor.ts
+++ b/packages/core/src/editor/Editor.ts
@@ -391,20 +391,19 @@ import { TranslationsConfig } from '../i18n/config';
* Fires when the escape key is pressed. The event property
* contains the key event.
*
- * ### Constructor: Editor
- *
- * Constructs a new editor. This function invokes the {@link onInit} callback
- * upon completion.
- *
- * ```javascript
- * var config = mxUtils.load('config/diagrameditor.xml').getDocumentElement();
- * var editor = new Editor(config);
- * ```
- *
- * @class Editor
- * @extends EventSource
+ * @category Editor
*/
export class Editor extends EventSource {
+ /**
+ * Constructs a new editor. This function invokes the {@link onInit} callback upon completion.
+ *
+ * ```javascript
+ * const config = load('config/diagram-editor.xml').getDocumentElement();
+ * const editor = new Editor(config);
+ * ```
+ *
+ * @param config The configuration element that contains the editor configuration.
+ */
constructor(config: Element) {
super();
diff --git a/packages/core/src/editor/EditorKeyHandler.ts b/packages/core/src/editor/EditorKeyHandler.ts
index 8b234faafd..154745068d 100644
--- a/packages/core/src/editor/EditorKeyHandler.ts
+++ b/packages/core/src/editor/EditorKeyHandler.ts
@@ -22,21 +22,28 @@ import KeyHandler from '../view/handler/KeyHandler';
import Editor from './Editor';
/**
- * Binds keycodes to action names in an editor. This aggregates an internal {@link handler} and extends the implementation of {@link KeyHandler.escape} to not only cancel the editing, but also hide the properties dialog and fire an event via {@link editor}. An instance of this class is created by {@link Editor} and stored in {@link Editor.keyHandler}.
+ * Binds keycodes to action names in an editor.
*
- * @Example
+ * This aggregates an internal {@link handler} and extends the implementation of {@link KeyHandler.escape} to not only cancel the editing,
+ * but also hide the properties dialog and fire an {@link InternalEvent.ESCAPE} event via {@link editor}.
+ *
+ * An instance of this class is created by {@link Editor} and stored in {@link Editor.keyHandler}.
+ *
+ * ### Example
* Bind the delete key to the delete action in an existing editor.
* ```javascript
- * var keyHandler = new EditorKeyHandler(editor);
+ * const keyHandler = new EditorKeyHandler(editor);
* keyHandler.bindAction(46, 'delete');
* ```
*
- * @Codec
- * This class uses the {@link DefaultKeyHandlerCodec} to read configuration data into an existing instance. See {@link DefaultKeyHandlerCodec} for a description of the configuration format.
+ * ### Codec
+ * This class uses the {@link EditorKeyHandlerCodec} to read configuration data into an existing instance. See {@link EditorKeyHandlerCodec} for a description of the configuration format.
*
- * @Keycodes
+ * ### Keycodes
* See {@link KeyHandler}.
* An {@link InternalEvent.ESCAPE} event is fired via the editor if the escape key is pressed.
+ *
+ * @category Editor
*/
export class EditorKeyHandler {
constructor(editor: Editor | null = null) {
diff --git a/packages/core/src/editor/EditorPopupMenu.ts b/packages/core/src/editor/EditorPopupMenu.ts
index f1b4044e19..5a855e6ad2 100644
--- a/packages/core/src/editor/EditorPopupMenu.ts
+++ b/packages/core/src/editor/EditorPopupMenu.ts
@@ -25,11 +25,18 @@ import Editor from './Editor';
import { PopupMenuItem } from '../types';
/**
- * Creates popupmenus for mouse events. This object holds an XML node which is a description of the popup menu to be created. In {@link createMenu}, the configuration is applied to the context and the resulting menu items are added to the menu dynamically. See {@link createMenu} for a description of the configuration format.
- * This class does not create the DOM nodes required for the popup menu, it only parses an XML description to invoke the respective methods on an {@link mxPopupMenu} each time the menu is displayed.
+ * Creates popupmenus for mouse events.
*
- * @Codec
- * This class uses the {@link DefaultPopupMenuCodec} to read configuration data into an existing instance, however, the actual parsing is done by this class during program execution, so the format is described below.
+ * This object holds an XML node which is a description of the popup menu to be created.
+ * In {@link createMenu}, the configuration is applied to the context and the resulting menu items are added to the menu dynamically.
+ * See {@link createMenu} for a description of the configuration format.
+ *
+ * This class does not create the DOM nodes required for the popup menu, it only parses an XML description to invoke the respective methods on an {@link MaxPopupMenu} each time the menu is displayed.
+ *
+ * ### Codec
+ * This class uses the {@link EditorPopupMenuCodec} to read configuration data into an existing instance, however, the actual parsing is done by this class during program execution, so the format is described below.
+ *
+ * @category Editor
*/
export class EditorPopupMenu {
constructor(config: Element | null = null) {
diff --git a/packages/core/src/editor/EditorToolbar.ts b/packages/core/src/editor/EditorToolbar.ts
index 46296abaa3..ae7830a6e8 100644
--- a/packages/core/src/editor/EditorToolbar.ts
+++ b/packages/core/src/editor/EditorToolbar.ts
@@ -30,28 +30,31 @@ import EventObject from '../view/event/EventObject';
import type { DropHandler } from '../view/other/DragSource';
/**
- * Toolbar for the editor. This modifies the state of the graph
- * or inserts new cells upon mouse clicks.
+ * Toolbar for the editor.
*
- * @Example:
+ * This modifies the state of the graph or inserts new cells upon mouse clicks.
+ *
+ * ### Example
*
* Create a toolbar with a button to copy the selection into the clipboard,
* and a combo box with one action to paste the selection from the clipboard
* into the graph.
*
* ```
- * var toolbar = new EditorToolbar(container, editor);
+ * const toolbar = new EditorToolbar(container, editor);
* toolbar.addItem('Copy', null, 'copy');
*
- * var combo = toolbar.addActionCombo('More actions...');
+ * const combo = toolbar.addActionCombo('More actions...');
* toolbar.addActionOption(combo, 'Paste', 'paste');
* ```
*
- * @Codec:
+ * ### Codec
*
* This class uses the {@link DefaultToolbarCodec} to read configuration
* data into an existing instance. See {@link DefaultToolbarCodec} for a
* description of the configuration format.
+ *
+ * @category Editor
*/
export class EditorToolbar {
constructor(container: HTMLElement | null = null, editor: Editor | null = null) {
@@ -116,7 +119,7 @@ export class EditorToolbar {
}
);
- // Resets the selected tool after a doubleclick or escape keystroke
+ // Resets the selected tool after a double click or escape keystroke
this.resetHandler = () => {
if (this.toolbar != null) {
this.toolbar.resetMode(true);
diff --git a/packages/core/src/gui/MaxForm.ts b/packages/core/src/gui/MaxForm.ts
index 220e78e237..c0532c05ab 100644
--- a/packages/core/src/gui/MaxForm.ts
+++ b/packages/core/src/gui/MaxForm.ts
@@ -24,7 +24,7 @@ import Translations from '../i18n/Translations';
/**
* A simple class for creating HTML forms.
*
- * @class MaxForm
+ * @category GUI
*/
class MaxForm {
constructor(className: string) {
diff --git a/packages/core/src/gui/MaxLog.ts b/packages/core/src/gui/MaxLog.ts
index 9437e3f3bc..c4e12f59cc 100644
--- a/packages/core/src/gui/MaxLog.ts
+++ b/packages/core/src/gui/MaxLog.ts
@@ -28,6 +28,9 @@ import { VERSION } from '../util/Constants';
/**
* A singleton class that implements a simple console.
+ *
+ * @category GUI
+ * @category Logging
*/
class MaxLog {
static textarea: HTMLTextAreaElement | null = null;
diff --git a/packages/core/src/gui/MaxLogAsLogger.ts b/packages/core/src/gui/MaxLogAsLogger.ts
index fa5ad647f4..9ad9e3d80f 100644
--- a/packages/core/src/gui/MaxLogAsLogger.ts
+++ b/packages/core/src/gui/MaxLogAsLogger.ts
@@ -24,6 +24,7 @@ import MaxLog from './MaxLog';
*
* @experimental subject to change or removal. The logging system may be modified in the future without prior notice.
* @since 0.11.0
+ * @category GUI
* @category Logging
*/
export class MaxLogAsLogger implements Logger {
diff --git a/packages/core/src/gui/MaxPopupMenu.ts b/packages/core/src/gui/MaxPopupMenu.ts
index efae69e4db..ecee8fa269 100644
--- a/packages/core/src/gui/MaxPopupMenu.ts
+++ b/packages/core/src/gui/MaxPopupMenu.ts
@@ -47,6 +47,8 @@ import type { PopupMenuItem } from '../types';
* ### `InternalEvent.SHOW`
*
* Fires after the menu has been shown in {@link popup}.
+ *
+ * @category GUI
*/
class MaxPopupMenu extends EventSource {
constructor(
diff --git a/packages/core/src/gui/MaxToolbar.ts b/packages/core/src/gui/MaxToolbar.ts
index c3c591a161..b3cbc8ec0b 100644
--- a/packages/core/src/gui/MaxToolbar.ts
+++ b/packages/core/src/gui/MaxToolbar.ts
@@ -43,6 +43,7 @@ export interface HTMLImageElementWithProps extends HTMLImageElement {
* Fires when an item was selected in the toolbar. The EventObject {@link InternalEvent.function}
* property contains the function that was selected in {@link selectMode}.
*
+ * @category GUI
*/
class MaxToolbar extends EventSource {
constructor(container: HTMLElement) {
diff --git a/packages/core/src/gui/MaxWindow.ts b/packages/core/src/gui/MaxWindow.ts
index c840b2c5c4..8159c2bf8d 100644
--- a/packages/core/src/gui/MaxWindow.ts
+++ b/packages/core/src/gui/MaxWindow.ts
@@ -176,8 +176,7 @@ let activeWindow: MaxWindow | null = null;
*
* Fires before the window is destroyed. This event has no properties.
*
- * @class MaxWindow
- * @extends EventSource
+ * @category GUI
*/
class MaxWindow extends EventSource {
constructor(
diff --git a/packages/core/src/i18n/Translations.ts b/packages/core/src/i18n/Translations.ts
index 17996ad427..b0a30c178c 100644
--- a/packages/core/src/i18n/Translations.ts
+++ b/packages/core/src/i18n/Translations.ts
@@ -72,6 +72,8 @@ import { TranslationsConfig } from './config';
* ## Loading default resources
*
* Call {@link loadResources} to load the default resources file for both {@link Graph} and {@link Editor}.
+ *
+ * @category I18n
*/
class Translations {
/*
diff --git a/packages/core/src/i18n/config.ts b/packages/core/src/i18n/config.ts
index 9279b347b7..5329c11a59 100644
--- a/packages/core/src/i18n/config.ts
+++ b/packages/core/src/i18n/config.ts
@@ -37,12 +37,25 @@ const values: TranslationsConfigValuesType = {
const originalValues: TranslationsConfigValuesType = {};
shallowCopy(values, originalValues);
+/**
+ * Resets {@link TranslationsConfig} to default values.
+ *
+ * @experimental Subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
+ * @since 0.16.0
+ * @category Configuration
+ * @category I18n
+ */
export const resetTranslationsConfig = (): void => {
shallowCopy(originalValues, values);
};
/**
* Global configuration for {@link Translations}.
+ *
+ * @experimental subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
+ * @since 0.16.0
+ * @category Configuration
+ * @category I18n
*/
export const TranslationsConfig = {
/**
diff --git a/packages/core/src/serialization/register-model-codecs.ts b/packages/core/src/serialization/register-model-codecs.ts
index 4005239e3b..e0809d9634 100644
--- a/packages/core/src/serialization/register-model-codecs.ts
+++ b/packages/core/src/serialization/register-model-codecs.ts
@@ -40,6 +40,7 @@ let isModelCodecsRegistered = false;
* if they have never been registered before.
* @since 0.10.0
* @category Configuration
+ * @category Serialization with Codecs
*/
export const registerModelCodecs = (force = false) => {
if (!isModelCodecsRegistered || force) {
diff --git a/packages/core/src/serialization/register-other-codecs.ts b/packages/core/src/serialization/register-other-codecs.ts
index 821b84cd72..40f1e65d4e 100644
--- a/packages/core/src/serialization/register-other-codecs.ts
+++ b/packages/core/src/serialization/register-other-codecs.ts
@@ -67,6 +67,7 @@ let isCoreCodecsRegistered = false;
* if they have never been registered before.
* @since 0.6.0
* @category Configuration
+ * @category Serialization with Codecs
*/
export const registerCoreCodecs = (force = false) => {
if (!isCoreCodecsRegistered || force) {
@@ -91,6 +92,7 @@ let isEditorCodecsRegistered = false;
* if they have never been registered before.
* @since 0.6.0
* @category Configuration
+ * @category Serialization with Codecs
*/
export const registerEditorCodecs = (force = false) => {
if (!isEditorCodecsRegistered || force) {
@@ -112,6 +114,7 @@ export const registerEditorCodecs = (force = false) => {
* if they have never been registered before.
* @since 0.6.0
* @category Configuration
+ * @category Serialization with Codecs
*/
export const registerAllCodecs = (force = false) => {
registerCoreCodecs(force);
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
index b83c628789..1b4b34665d 100644
--- a/packages/core/src/types.ts
+++ b/packages/core/src/types.ts
@@ -35,10 +35,12 @@ export type UndoableChange = {
redo?: () => void;
};
+/** @category Style */
export type StyleValue = string | number;
export type Properties = Record;
+/** @category Style */
export type CellStyle = CellStateStyle & {
/**
* Names of styles used to fill properties before applying the specific properties defined in {@link CellStateStyle}.
@@ -66,6 +68,7 @@ export type CellStyle = CellStateStyle & {
ignoreDefaultStyle?: boolean;
};
+/** @category Style */
export type CellStateStyle = {
/**
* This specifies if {@link arcSize} for rectangles is absolute or relative.
@@ -871,14 +874,19 @@ export type CellStateStyle = {
whiteSpace?: WhiteSpaceValue;
};
+/** @category Style */
export type NumericCellStateStyleKeys = NonNullable<
{
[k in keyof CellStateStyle]: CellStateStyle[k] extends number | undefined ? k : never;
}[keyof CellStateStyle]
>;
+/** @category Style */
export type ColorValue = string;
-/** Color values and special placeholders used to resolve colors (see {@link CellRenderer.resolveColor}) for style properties. */
+/**
+ * Color values and special placeholders used to resolve colors (see {@link CellRenderer.resolveColor}) for style properties.
+ * @category Style
+ */
export type SpecialStyleColorValue =
| 'indicated'
| 'inherit'
@@ -886,14 +894,21 @@ export type SpecialStyleColorValue =
| 'swimlane'
| (string & {});
+/** @category Style */
export type DirectionValue = 'north' | 'south' | 'east' | 'west';
+/** @category Style */
export type TextDirectionValue = '' | 'ltr' | 'rtl' | 'auto';
+/** @category Style */
export type AlignValue = 'left' | 'center' | 'right';
+/** @category Style */
export type VAlignValue = 'top' | 'middle' | 'bottom';
+/** @category Style */
export type OverflowValue = 'fill' | 'width' | 'auto' | 'hidden' | 'scroll' | 'visible';
+/** @category Style */
export type WhiteSpaceValue = 'normal' | 'wrap' | 'nowrap' | 'pre';
/**
* Names used to register the edge markers provided out-of-the-box by maxGraph with {@link MarkerShape.addMarker}.
+ * @category Style
*/
export type ArrowValue =
| 'none'
@@ -909,11 +924,13 @@ export type ArrowValue =
/**
* {@link ArrowValue} with support for extensions.
+ * @category Style
*/
export type StyleArrowValue = ArrowValue | (string & {});
/**
* Names used to register the shapes provided out-of-the-box by maxGraph with {@link CellRenderer.registerShape}.
+ * @category Style
*/
export type ShapeValue =
| 'rectangle'
@@ -935,6 +952,7 @@ export type ShapeValue =
/**
* {@link ShapeValue} with support for extensions.
+ * @category Style
*/
export type StyleShapeValue = ShapeValue | (string & {});
@@ -1067,11 +1085,13 @@ export type VertexParameters = {
y?: number;
};
+/** @category Plugin */
export interface GraphPluginConstructor {
- new (graph: Graph): GraphPlugin;
pluginId: string;
+ new (graph: Graph): GraphPlugin;
}
+/** @category Plugin */
export interface GraphPlugin {
onDestroy: () => void;
}
@@ -1179,6 +1199,9 @@ export type PerimeterValue =
* @param target {@link CellState} that represents the target terminal.
* @param points List of relative control points.
* @param result Array of {@link Point} that represent the actual points of the edge.
+ *
+ * @since 0.8.0
+ * @category EdgeStyle
*/
export type EdgeStyleFunction = (
state: CellState,
@@ -1191,6 +1214,7 @@ export type EdgeStyleFunction = (
/**
* Names used to register the edge styles (a.k.a. connectors) provided out-of-the-box by maxGraph with {@link StyleRegistry.putValue}.
* @since 0.14.0
+ * @category EdgeStyle
*/
export type EdgeStyleValue =
| 'elbowEdgeStyle'
@@ -1205,6 +1229,7 @@ export type EdgeStyleValue =
/**
* {@link EdgeStyleValue} with support for extensions and {@link EdgeStyleFunction}.
* @since 0.14.0
+ * @category EdgeStyle
*/
export type StyleEdgeStyleValue =
| EdgeStyleFunction
@@ -1214,6 +1239,7 @@ export type StyleEdgeStyleValue =
/**
* @since 0.11.0
+ * @category Style
*/
export type MarkerFactoryFunction = (
canvas: AbstractCanvas2D,
diff --git a/packages/core/src/util/MaxXmlRequest.ts b/packages/core/src/util/MaxXmlRequest.ts
index 350a7399d8..36446da376 100644
--- a/packages/core/src/util/MaxXmlRequest.ts
+++ b/packages/core/src/util/MaxXmlRequest.ts
@@ -219,7 +219,7 @@ class MaxXmlRequest {
}
/**
- * Returns the status as a number, eg. 404 for "Not found" or 200 for "OK".
+ * Returns the status as a number, e.g. 404 for "Not found" or 200 for "OK".
* Note: The NS_ERROR_NOT_AVAILABLE for invalid responses cannot be caught.
*/
getStatus(): number {
@@ -240,13 +240,12 @@ class MaxXmlRequest {
}
/**
- * Send the to the target URL using the specified functions to
- * process the response asychronously.
+ * Send the {@link request} to the target URL using the specified functions to process the response asynchronously.
*
- * Note: Due to technical limitations, onerror is currently ignored.
+ * Note: Due to technical limitations, `onerror` is currently ignored.
*
* @param onload Function to be invoked if a successful response was received.
- * @param onerror Function to be called on any error. Unused in this implementation, intended for overriden function.
+ * @param onerror Function to be called on any error. Unused in this implementation, intended for overridden function.
* @param timeout Optional timeout in ms before calling ontimeout.
* @param ontimeout Optional function to execute on timeout.
*/
@@ -518,18 +517,16 @@ export const getAll = (
};
/**
- * Posts the specified params to the given URL *asynchronously* and invokes
- * the given functions depending on the request status. Returns the
- * in use. Both functions take the as the
- * only parameter. Make sure to use encodeURIComponent for the parameter
- * values.
+ * Posts the specified params to the given URL *asynchronously* and invokes the given functions depending on the request status.
+ * Returns the {@link MaxXmlRequest} in use.
+ * Both functions take the {@link MaxXmlRequest} as the only parameter.
+ * Make sure to use encodeURIComponent for the parameter values.
*
* Example:
*
* ```javascript
- * mxUtils.post(url, 'key=value', (req)=>
- * {
- * mxUtils.alert('Ready: '+req.isReady()+' Status: '+req.getStatus());
+ * post(url, 'key=value', (req) => {
+ * alert('Ready: ' + req.isReady() + ' Status: ' + req.getStatus());
* // Process req.getDocumentElement() using DOM API if OK...
* });
* ```
diff --git a/packages/core/src/view/cell/register-shapes.ts b/packages/core/src/view/cell/register-shapes.ts
index 4ab8056cf3..6ffd68221e 100644
--- a/packages/core/src/view/cell/register-shapes.ts
+++ b/packages/core/src/view/cell/register-shapes.ts
@@ -39,7 +39,9 @@ let isDefaultElementsRegistered = false;
/**
* Add default shapes into `CellRenderer` shapes.
*
+ * @private
* @category Configuration
+ * @category Style
*/
export function registerDefaultShapes() {
if (!isDefaultElementsRegistered) {
diff --git a/packages/core/src/view/geometry/edge/MarkerShape.ts b/packages/core/src/view/geometry/edge/MarkerShape.ts
index 25fffef3ba..aba3eb0eb9 100644
--- a/packages/core/src/view/geometry/edge/MarkerShape.ts
+++ b/packages/core/src/view/geometry/edge/MarkerShape.ts
@@ -253,7 +253,9 @@ function diamond(
let isDefaultMarkersRegistered = false;
/**
+ * @private
* @category Configuration
+ * @category Style
*/
export const registerDefaultEdgeMarkers = (): void => {
if (!isDefaultMarkersRegistered) {
diff --git a/packages/core/src/view/style/EdgeStyle.ts b/packages/core/src/view/style/EdgeStyle.ts
index 9ad87865a8..a2b70b33ca 100644
--- a/packages/core/src/view/style/EdgeStyle.ts
+++ b/packages/core/src/view/style/EdgeStyle.ts
@@ -78,6 +78,8 @@ import { TopToBottom as TopToBottomFunction } from './edge/TopToBottom';
* ```javascript
* style.edgeStyle = EdgeStyle.MyStyle;
* ```
+ *
+ * @category EdgeStyle
*/
class EdgeStyle {
/**
diff --git a/packages/core/src/view/style/StyleRegistry.ts b/packages/core/src/view/style/StyleRegistry.ts
index 0e1100e6fe..d9dde198e6 100644
--- a/packages/core/src/view/style/StyleRegistry.ts
+++ b/packages/core/src/view/style/StyleRegistry.ts
@@ -17,8 +17,11 @@ limitations under the License.
*/
/**
- * Singleton class that acts as a global converter from string to object values
- * in a style. This is currently only used to perimeters and edge styles.
+ * Singleton class that acts as a global converter from string to object values in a style.
+ *
+ * This is currently only used for handling perimeters and edge styles.
+ *
+ * @category Style
*/
class StyleRegistry {
/**
diff --git a/packages/core/src/view/style/Stylesheet.ts b/packages/core/src/view/style/Stylesheet.ts
index 65a4345285..7e4e2b387f 100644
--- a/packages/core/src/view/style/Stylesheet.ts
+++ b/packages/core/src/view/style/Stylesheet.ts
@@ -43,6 +43,8 @@ import type { CellStateStyle, CellStyle } from '../../types';
* const defaultEdgeStyle = stylesheet.getDefaultEdgeStyle();
* defaultEdgeStyle.edgeStyle = EdgeStyle.EntityRelation;
* ```
+ *
+ * @category Style
*/
export class Stylesheet {
constructor() {
diff --git a/packages/core/src/view/style/config.ts b/packages/core/src/view/style/config.ts
index 915a395311..568c99018e 100644
--- a/packages/core/src/view/style/config.ts
+++ b/packages/core/src/view/style/config.ts
@@ -24,6 +24,7 @@ import type { DirectionValue } from '../../types';
* @experimental subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.15.0
* @category Configuration
+ * @category EdgeStyle
*/
export const EntityRelationConnectorConfig = {
/**
@@ -40,6 +41,7 @@ export const EntityRelationConnectorConfig = {
* @experimental Subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.15.0
* @category Configuration
+ * @category EdgeStyle
*/
export const resetEntityRelationConnectorConfig = (): void => {
// implement the reset manually as there are a few properties for now
@@ -52,6 +54,7 @@ export const resetEntityRelationConnectorConfig = (): void => {
* @experimental subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.16.0
* @category Configuration
+ * @category EdgeStyle
*/
export const OrthogonalConnectorConfig = {
/**
@@ -78,6 +81,7 @@ const originalOrthogonalConnectorConfig = { ...OrthogonalConnectorConfig };
* @experimental Subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.16.0
* @category Configuration
+ * @category EdgeStyle
*/
export const resetOrthogonalConnectorConfig = (): void => {
shallowCopy(originalOrthogonalConnectorConfig, OrthogonalConnectorConfig);
@@ -119,6 +123,7 @@ export type ManhattanConnectorConfigType = {
* @experimental subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.16.0
* @category Configuration
+ * @category EdgeStyle
*/
export const ManhattanConnectorConfig: ManhattanConnectorConfigType = {
maxAllowedDirectionChange: 90,
@@ -136,6 +141,7 @@ shallowCopy(ManhattanConnectorConfig, originalManhattanConnectorConfig);
* @experimental Subject to change or removal. maxGraph's global configuration may be modified in the future without prior notice.
* @since 0.16.0
* @category Configuration
+ * @category EdgeStyle
*/
export const resetManhattanConnectorConfig = (): void => {
shallowCopy(originalManhattanConnectorConfig, ManhattanConnectorConfig);
diff --git a/packages/core/src/view/style/register.ts b/packages/core/src/view/style/register.ts
index 9d25672f02..9ae164caff 100644
--- a/packages/core/src/view/style/register.ts
+++ b/packages/core/src/view/style/register.ts
@@ -24,7 +24,9 @@ let isDefaultsRegistered = false;
/**
* Register style elements for "EdgeStyle" and "Perimeters".
*
+ * @private
* @category Configuration
+ * @category Style
*/
export const registerDefaultStyleElements = (): void => {
if (!isDefaultsRegistered) {
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
index c7a1f90ad1..12d7040eb2 100644
--- a/packages/core/tsconfig.json
+++ b/packages/core/tsconfig.json
@@ -15,22 +15,28 @@
"typedocOptions": {
"out": "build/api",
"readme": "none",
+ "excludeInternal": true,
"excludeExternals": true,
"excludePrivate": true,
"categoryOrder": [
"Configuration",
- "Logging",
"Edge Shapes",
"Vertex Shapes",
+ "EdgeStyle",
+ "Editor",
+ "GUI",
+ "I18n",
"Layout",
+ "Logging",
"Perimeter",
"Plugin",
"Serialization with Codecs",
+ "Style",
"*"
],
"categorizeByGroup": false,
"navigation": {
- "includeCategories": false, // not enough categories to warrant this
+ "includeCategories": true, // not enough categories to warrant this
},
}
}