Skip to content

refactor: improve types usage in PageBreaksMixin #956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbouffard merged 1 commit into from
Nov 24, 2025
Merged

refactor: improve types usage in PageBreaksMixin #956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 43 additions & 47 deletions packages/core/src/view/mixins/PageBreaksMixin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import Rectangle from '../geometry/Rectangle.js';
import Point from '../geometry/Point.js';
import PolylineShape from '../shape/edge/PolylineShape.js';
import type { AbstractGraph } from '../AbstractGraph.js';
import type Shape from '../shape/Shape.js';

type PartialGraph = Pick<
AbstractGraph,
Expand Down Expand Up @@ -77,56 +78,51 @@ export const PageBreaksMixin: PartialType = {
this.verticalPageBreaks = [];
}

const drawPageBreaks = (breaks: any) => {
if (breaks != null) {
const count =
breaks === this.horizontalPageBreaks ? horizontalCount : verticalCount;

for (let i = 0; i <= count; i += 1) {
const pts =
breaks === this.horizontalPageBreaks
? [
new Point(
Math.round(bounds.x),
Math.round(bounds.y + i * bounds.height)
),
new Point(
Math.round(bounds.x + right),
Math.round(bounds.y + i * bounds.height)
),
]
: [
new Point(
Math.round(bounds.x + i * bounds.width),
Math.round(bounds.y)
),
new Point(
Math.round(bounds.x + i * bounds.width),
Math.round(bounds.y + bottom)
),
];

if (breaks[i] != null) {
breaks[i].points = pts;
breaks[i].redraw();
} else {
const pageBreak = new PolylineShape(pts, this.getPageBreakColor());
pageBreak.dialect = this.getDialect();
pageBreak.pointerEvents = false;
pageBreak.isDashed = this.isPageBreakDashed();
pageBreak.init(this.getView().backgroundPane);
pageBreak.redraw();

breaks[i] = pageBreak;
}
}

for (let i = count; i < breaks.length; i += 1) {
breaks[i].destroy();
const drawPageBreaks = (breaks: Shape[] | null) => {
if (!breaks) {
return;
}
const count =
breaks === this.horizontalPageBreaks ? horizontalCount : verticalCount;

for (let i = 0; i <= count; i += 1) {
const pts =
breaks === this.horizontalPageBreaks
? [
new Point(Math.round(bounds.x), Math.round(bounds.y + i * bounds.height)),
new Point(
Math.round(bounds.x + right),
Math.round(bounds.y + i * bounds.height)
),
]
: [
new Point(Math.round(bounds.x + i * bounds.width), Math.round(bounds.y)),
new Point(
Math.round(bounds.x + i * bounds.width),
Math.round(bounds.y + bottom)
),
];

if (breaks[i] != null) {
breaks[i].points = pts;
breaks[i].redraw();
} else {
const pageBreak = new PolylineShape(pts, this.getPageBreakColor());
pageBreak.dialect = this.getDialect();
pageBreak.pointerEvents = false;
pageBreak.isDashed = this.isPageBreakDashed();
pageBreak.init(this.getView().backgroundPane);
pageBreak.redraw();

breaks[i] = pageBreak;
}
}

breaks.splice(count, breaks.length - count);
for (let i = count; i < breaks.length; i += 1) {
breaks[i].destroy();
}

breaks.splice(count, breaks.length - count);
};

drawPageBreaks(this.horizontalPageBreaks);
Expand Down
8 changes: 3 additions & 5 deletions packages/core/src/view/mixins/PageBreaksMixin.type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,15 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

// TODO TMP workaround, need an import, otherwise TSC complains
// TS2436: Ambient module declaration cannot specify relative module name.
export {};
import type Shape from '../shape/Shape.js';

declare module '../AbstractGraph' {
interface AbstractGraph {
/** @default null */
horizontalPageBreaks: any[] | null;
horizontalPageBreaks: Shape[] | null;

/** @default null */
verticalPageBreaks: any[] | null;
verticalPageBreaks: Shape[] | null;

/**
* Invokes from {@link sizeDidChange} to redraw the page breaks.
Expand Down