Skip to content

Commit d4029fd

Browse files
authored
refactor: remove "mx" prefixes in comments (#3354)
There is no reason to tight them to the mxGraph convention and this prefix made things harder to understand. This change will also reduce the amount of work to do when switching to another rendering library.
1 parent f9125f9 commit d4029fd

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

src/component/BpmnVisualization.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ import { BpmnModelRegistry } from './registry/bpmn-model-registry';
3838
*/
3939
export class BpmnVisualization {
4040
/**
41-
* Direct access to the `mxGraph` instance that powers `bpmn-visualization`.
42-
* It is for **advanced users**, so please use the lib API first and access to the `mxGraph` instance only when there is no alternative.
41+
* Direct access to the `Graph` instance that powers `bpmn-visualization`.
42+
* It is for **advanced users**, so please use the lib API first and access to the `Graph` instance only when there is no alternative.
4343
*
4444
* **WARN**: subject to change, could be removed or made available in another way.
4545
*
@@ -74,7 +74,7 @@ export class BpmnVisualization {
7474

7575
constructor(options: GlobalOptions) {
7676
this.rendererOptions = options?.renderer;
77-
// mxgraph configuration
77+
// graph configuration
7878
const configurator = new GraphConfigurator(htmlElement(options?.container));
7979
this.graph = configurator.configure();
8080
// other configurations

src/component/mxgraph/shape/render/icon-painter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export class IconPainter {
9797
/**
9898
* Utility paint icon methods to easily instantiate a {@link BpmnCanvas} from a {@link PaintParameter}.
9999
*
100-
* @param canvas mxgraph `mxAbstractCanvas2D` in charge of performing the paint operations.
100+
* @param canvas `mxAbstractCanvas2D` in charge of performing the paint operations.
101101
* @param ratioFromParent the actual size of the icon will be computed from the shape dimensions using this ratio.
102102
* @param setIconOriginFunct called function to set the origin of the icon. Generally, it calls a method of {@link BpmnCanvas}.
103103
* @param shapeConfig dimension and style of the shape where the icon is painted.

src/component/navigation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export class NavigationImpl implements Navigation {
7272

7373
panningHandler.usePopupTrigger = false; // only use the left button to trigger panning
7474
// Reimplement the function as we also want to trigger 'panning on cells' (ignoreCell to true) and only on left-click
75-
// The mxGraph standard implementation doesn't ignore right click in this case, so do it by ourselves
75+
// The regular implementation doesn't ignore right click in this case, so do it by ourselves
7676
panningHandler.isForcePanningEvent = (me: mxMouseEvent): boolean => mxEvent.isLeftMouseButton(me.getEvent()) || mxEvent.isMultiTouchEvent(me.getEvent());
7777
this.graph.setPanning(true);
7878

0 commit comments

Comments
 (0)