-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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.
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
TypeScript Reporting Layouts #22454
TypeScript Reporting Layouts #22454
Changes from 11 commits
6e7c5fb
f2108a3
704d79f
b9e7482
6d805c5
9e83af3
8979f2e
4d0d3d0
af4257a
4464fb2
ca4b974
a285cbf
ced32f9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,4 @@ | |
export const LayoutTypes = { | ||
PRESERVE_LAYOUT: 'preserve_layout', | ||
PRINT: 'print', | ||
}; | ||
}; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { Size } from '../../../../../types'; | ||
|
||
export interface CaptureConfig { | ||
zoom: number; | ||
viewport: Size; | ||
} | ||
|
||
export interface ViewZoomWidthHeight { | ||
zoom: number; | ||
width: number; | ||
height: number; | ||
} |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
export { createLayout } from './layout_factory'; | ||
export { PrintLayout } from './print_layout'; | ||
export { PreserveLayout } from './preserve_layout'; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { Size } from '../../../../../types'; | ||
import { ViewZoomWidthHeight } from './index.d'; | ||
|
||
export interface PageSizeParams { | ||
pageMarginTop: number; | ||
pageMarginBottom: number; | ||
pageMarginWidth: number; | ||
tableBorderWidth: number; | ||
headingHeight: number; | ||
subheadingHeight: number; | ||
} | ||
|
||
export interface PdfImageSize { | ||
width: number; | ||
height?: number; | ||
} | ||
|
||
export abstract class Layout { | ||
public id: string = ''; | ||
|
||
constructor(id: string) { | ||
this.id = id; | ||
} | ||
|
||
public abstract getPdfImageSize(): PdfImageSize; | ||
|
||
public abstract getPdfPageOrientation(): string | undefined; | ||
|
||
public abstract getPdfPageSize(pageSizeParams: PageSizeParams): string | Size; | ||
|
||
public abstract getViewport(itemsCount: number): ViewZoomWidthHeight; | ||
|
||
public abstract getBrowserZoom(): number; | ||
|
||
public abstract getBrowserViewport(): Size; | ||
|
||
public abstract getCssOverridesPath(): string; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import { KbnServer, Size } from '../../../../../types'; | ||
import { LayoutTypes } from '../../../common/constants'; | ||
import { Layout } from './layout'; | ||
import { PreserveLayout } from './preserve_layout'; | ||
import { PrintLayout } from './print_layout'; | ||
|
||
interface LayoutParams { | ||
id: string; | ||
dimensions: Size; | ||
} | ||
|
||
export function createLayout(server: KbnServer, layoutParams: LayoutParams): Layout { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. let's call this file |
||
if (layoutParams && layoutParams.id === LayoutTypes.PRESERVE_LAYOUT) { | ||
return new PreserveLayout(layoutParams.id, layoutParams.dimensions); | ||
} | ||
|
||
// this is the default because some jobs won't have anything specified | ||
return new PrintLayout(server, layoutParams.id); | ||
} |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
import path from 'path'; | ||
import { Size } from '../../../../../types'; | ||
import { Layout, PageSizeParams } from './layout'; | ||
|
||
const ZOOM: number = 2; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Zoom used to be a param that could be passed in from a caller, but 2 was the default. This makes it completely hardcoded. Also, you've removed the explanatory comments: https://github.com/elastic/kibana/blob/master/x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/preserve_layout.js#L9-L12 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Intentional. This setting was never exposed to the user as configurable - #20091 I don't think we ever will expose it. The only reason we use it is to make sure the resolution is a little bigger on the screenshots. From Brandon in that above issue:
|
||
|
||
export class PreserveLayout extends Layout { | ||
public readonly selectors = { | ||
screenshot: '[data-shared-items-container]', | ||
renderComplete: '[data-shared-item]', | ||
itemsCountAttribute: 'data-shared-items-count', | ||
timefilterFromAttribute: 'data-shared-timefilter-from', | ||
timefilterToAttribute: 'data-shared-timefilter-to', | ||
}; | ||
|
||
public readonly groupCount = 1; | ||
private readonly height: number; | ||
private readonly width: number; | ||
private readonly scaledHeight: number; | ||
private readonly scaledWidth: number; | ||
|
||
constructor(id: string, size: Size) { | ||
super(id); | ||
this.height = size.height; | ||
this.width = size.width; | ||
this.scaledHeight = size.height * ZOOM; | ||
this.scaledWidth = size.width * ZOOM; | ||
} | ||
|
||
public getCssOverridesPath() { | ||
return path.join(__dirname, 'preserve_layout.css'); | ||
} | ||
|
||
public getBrowserViewport() { | ||
return { | ||
height: this.scaledHeight, | ||
width: this.scaledWidth, | ||
}; | ||
} | ||
|
||
public getBrowserZoom() { | ||
return ZOOM; | ||
} | ||
|
||
public getViewport() { | ||
return { | ||
height: this.scaledHeight, | ||
width: this.scaledWidth, | ||
zoom: ZOOM, | ||
}; | ||
} | ||
|
||
public getPdfImageSize() { | ||
return { | ||
height: this.height, | ||
width: this.width, | ||
}; | ||
} | ||
|
||
public getPdfPageOrientation() { | ||
return undefined; | ||
} | ||
|
||
public getPdfPageSize(pageSizeParams: PageSizeParams) { | ||
return { | ||
height: | ||
this.height + | ||
pageSizeParams.pageMarginTop + | ||
pageSizeParams.pageMarginBottom + | ||
pageSizeParams.tableBorderWidth * 2 + | ||
pageSizeParams.headingHeight + | ||
pageSizeParams.subheadingHeight, | ||
width: this.width + pageSizeParams.pageMarginWidth * 2 + pageSizeParams.tableBorderWidth * 2, | ||
}; | ||
} | ||
} |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't need the
.d
in the name, and I don't think you need to specifyindex
too. Try:import { ViewZoomWidthHeight } from '.';
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the record, this doesn't work because it resolves it to
index.js
which exists in the same location, so have to be explicit withindex.d.ts
. Maybe the file should just be namedtypes.d.ts
in that case. Which also matches our othertypes.d.ts
file.