@maxgraph/core/lib/esm/view/style/register.js

maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.

/*
Copyright 2024-present The maxGraph project Contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { EdgeStyle, EdgeMarker, Perimeter } from './builtin-style-elements.js';
import { EdgeStyleRegistry } from './edge/EdgeStyleRegistry.js';
import { EdgeMarkerRegistry } from './marker/EdgeMarkerRegistry.js';
import { PerimeterRegistry } from './perimeter/PerimeterRegistry.js';
let isDefaultEdgeStylesRegistered = false;
/**
 * Register default builtin {@link EdgeStyle}s in {@link EdgeStyleRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.18.0
 */
export const registerDefaultEdgeStyles = () => {
    if (!isDefaultEdgeStylesRegistered) {
        const edgeStylesToRegister = [
            ['elbowEdgeStyle', EdgeStyle.ElbowConnector, { handlerKind: 'elbow' }],
            ['entityRelationEdgeStyle', EdgeStyle.EntityRelation, {}],
            ['loopEdgeStyle', EdgeStyle.Loop, { handlerKind: 'elbow', isOrthogonal: false }],
            ['manhattanEdgeStyle', EdgeStyle.ManhattanConnector, { handlerKind: 'segment' }],
            ['orthogonalEdgeStyle', EdgeStyle.OrthConnector, { handlerKind: 'segment' }],
            ['segmentEdgeStyle', EdgeStyle.SegmentConnector, { handlerKind: 'segment' }],
            ['sideToSideEdgeStyle', EdgeStyle.SideToSide, { handlerKind: 'elbow' }],
            ['topToBottomEdgeStyle', EdgeStyle.TopToBottom, { handlerKind: 'elbow' }],
        ];
        for (const [name, edgeStyle, metadata] of edgeStylesToRegister) {
            EdgeStyleRegistry.add(name, edgeStyle, {
                ...metadata,
                // most edge styles registered here are orthogonal, so set to true by default to avoid to duplicate the configuration code
                isOrthogonal: metadata.isOrthogonal ?? true,
            });
        }
        isDefaultEdgeStylesRegistered = true;
    }
};
let isDefaultPerimetersRegistered = false;
/**
 * Register default builtin {@link Perimeter}s in {@link PerimeterRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.18.0
 */
export const registerDefaultPerimeters = () => {
    if (!isDefaultPerimetersRegistered) {
        const perimetersToRegister = [
            ['ellipsePerimeter', Perimeter.EllipsePerimeter],
            ['hexagonPerimeter', Perimeter.HexagonPerimeter],
            ['rectanglePerimeter', Perimeter.RectanglePerimeter],
            ['rhombusPerimeter', Perimeter.RhombusPerimeter],
            ['trianglePerimeter', Perimeter.TrianglePerimeter],
        ];
        for (const [name, perimeter] of perimetersToRegister) {
            PerimeterRegistry.add(name, perimeter);
        }
        isDefaultPerimetersRegistered = true;
    }
};
/**
 * Unregister all {@link EdgeStyle}s and {@link Perimeter}s from their registries.
 *
 * @see unregisterAllEdgeStyles
 * @see unregisterAllPerimeters
 *
 * @category Configuration
 * @category Style
 * @since 0.18.0
 */
export const unregisterAllEdgeStylesAndPerimeters = () => {
    unregisterAllEdgeStyles();
    unregisterAllPerimeters();
};
/**
 * Unregister all {@link EdgeStyle}s from {@link EdgeStyleRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.20.0
 */
export const unregisterAllEdgeStyles = () => {
    EdgeStyleRegistry.clear();
    isDefaultEdgeStylesRegistered = false;
};
/**
 * Unregister all {@link Perimeter}s from {@link PerimeterRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.20.0
 */
export const unregisterAllPerimeters = () => {
    PerimeterRegistry.clear();
    isDefaultPerimetersRegistered = false;
};
let isDefaultMarkersRegistered = false;
/**
 *
 * Register default builtin {@link MarkerFactoryFunction}s in {@link EdgeMarkerRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.18.0
 */
export const registerDefaultEdgeMarkers = () => {
    if (!isDefaultMarkersRegistered) {
        const markersToRegister = [
            ['classic', EdgeMarker.createArrow(2)],
            ['classicThin', EdgeMarker.createArrow(3)],
            ['block', EdgeMarker.createArrow(2)],
            ['blockThin', EdgeMarker.createArrow(3)],
            ['open', EdgeMarker.createOpenArrow(2)],
            ['openThin', EdgeMarker.createOpenArrow(3)],
            ['oval', EdgeMarker.oval],
            ['diamond', EdgeMarker.diamond],
            ['diamondThin', EdgeMarker.diamond],
        ];
        for (const [type, factory] of markersToRegister) {
            EdgeMarkerRegistry.add(type, factory);
        }
        isDefaultMarkersRegistered = true;
    }
};
/**
 * Unregister all {@link MarkerFactoryFunction}s from {@link EdgeMarkerRegistry}.
 *
 * @category Configuration
 * @category Style
 * @since 0.18.0
 */
export const unregisterAllEdgeMarkers = () => {
    EdgeMarkerRegistry.clear();
    isDefaultMarkersRegistered = false;
};