Report class
مكون تضمين تقرير Power BI
- يمتد
-
Embed
الخصائص
| bookmarks |
الأساليب
| add |
الأمر إضافة ملحق قائمة السياق.
|
| add |
الأمر إضافة ملحق قائمة خيارات.
|
| add |
إضافة صفحة فارغة إلى التقرير
|
| apply |
تطبيق نسق على التقرير
|
| are |
إرجاع إذا كانت هناك عوامل تصفية للمستخدم أو مقسمات طرق عرض أو تغييرات أخرى في طريقة عرض البيانات المطبقة على التقرير. إذا تم تعطيل عوامل التصفية الثابتة، فترجع false.
|
| clear |
مسح المرئيات المحددة غير المبرزة، إذا تم تمرير العلامة، مسح جميع تحديدات المرئيات.
|
| close |
إغلاق كافة قوائم السياق المفتوحة وتلميحات الأدوات.
|
| config |
معالجة تغييرات التكوين. |
| delete |
حذف صفحة من تقرير
|
| get |
الحصول على صفحة التقرير النشط.
|
| get |
يحصل على عوامل التصفية التي يتم تطبيقها على مستوى التقرير.
|
| get |
يحصل على معرف التقرير من الموقع المتوفر الأول: الخيارات، السمة، تضمين url. |
| get |
الحصول على صفحة تقرير باسمها.
|
| get |
الحصول على قائمة الصفحات داخل التقرير.
|
| get |
الحصول على موضوع التقرير
|
| get |
إرجاع مستوى التكبير/التصغير الحالي للتقرير. |
| is |
يتحقق من حفظ التقرير.
|
| move |
تحديث موضع عنصر تحكم في صفحة.
|
| print() | طباعة الصفحة النشطة للتقرير عن طريق استدعاء |
| refresh() | تحديث مصادر البيانات للتقرير.
|
| remove |
الأمر "إزالة ملحق قائمة السياق".
|
| remove |
إزالة كافة عوامل التصفية على مستوى التقرير.
|
| remove |
الأمر "إزالة ملحق قائمة الخيارات".
|
| rename |
إعادة تسمية صفحة من تقرير
|
| render(IReport |
عرض تقرير محمل مسبقا، باستخدام واجهة برمجة تطبيقات التضمين المرحلي
|
| reset |
إعادة تعيين عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى إلى الحالة الافتراضية للتقرير
|
| reset |
إعادة تعيين النسق الافتراضي للتقرير وتطبيقه
|
| resize |
تحديث حجم الصفحة النشطة في التقرير.
|
| resize |
تغيير حجم عنصر تحكم في صفحة.
|
| save |
حفظ عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى للتقرير
|
| set |
تعيين عوامل التصفية على مستوى التقرير.
|
| set |
تعيين الصفحة النشطة للتقرير.
|
| set |
تحديث حالة العرض لمرئية في صفحة.
|
| set |
تعيين مستوى التكبير/التصغير للتقرير. |
| switch |
تحديث تخطيط التقرير
|
| switch |
تبديل وضع طريقة عرض التقرير. |
| update |
قم بتحديث عوامل التصفية على مستوى التقرير وفقا للعملية: إضافة أو استبدال الكل أو استبداله بالهدف أو إزالته.
|
| update |
يحدث إعدادات الرؤية لجزء التصفية وجزء التنقل في الصفحة.
|
الأساليب المتوارثة
| exit |
يطلب من المستعرض الخروج من وضع ملء الشاشة. |
| fullscreen() | يطلب من المتصفح عرض iframe للمكون في وضع ملء الشاشة. |
| get |
احصل على correlationId لجلسة التضمين الحالية.
|
| off<T>(string, IEvent |
إزالة معالج حدث واحد أو أكثر من قائمة المعالجات. إذا تم تحديد مرجع إلى دالة المقبض الموجودة، فقم بإزالة المعالج المحدد. إذا لم يتم تحديد المعالج، فقم بإزالة كافة المعالجات لاسم الحدث المحدد.
|
| on<T>(string, IEvent |
إضافة معالج أحداث لحدث معين.
|
| reload() | إعادة تحميل التضمين باستخدام التكوين الموجود. على سبيل المثال، بالنسبة للتقارير، يقوم هذا بمسح جميع عوامل التصفية بشكل فعال ويجعل الصفحة الأولى نشطة والتي تحاكي إعادة تعيين تقرير إلى الحالة المحملة.
|
| remove |
إزالة سمة tabindex للعنصر |
| save() | حفظ التقرير. |
| save |
تقرير SaveAs. |
| set |
تعيين accessToken. |
| set |
تعيين سمة tabindex للعنصر |
| set |
تعيين عنوان المكون لإمكانية وصول ذوي الاحتياجات الخاصة. في حالة iframes، سيؤدي هذا الأسلوب إلى تغيير عنوان iframe. |
تفاصيل الخاصية
bookmarksManager
تفاصيل الأسلوب
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
الأمر إضافة ملحق قائمة السياق.
report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
.catch(error => {
...
});
function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
الأمر إضافة ملحق قائمة خيارات.
report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
.catch(error => {
...
});
function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
addPage(string)
إضافة صفحة فارغة إلى التقرير
// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");
function addPage(displayName?: string): Promise<Page>
المعلمات
- displayName
-
string
المرتجعات
Promise<Page>
applyTheme(IReportTheme)
تطبيق نسق على التقرير
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
المعلمات
- theme
- IReportTheme
المرتجعات
Promise<void>
arePersistentFiltersApplied()
إرجاع إذا كانت هناك عوامل تصفية للمستخدم أو مقسمات طرق عرض أو تغييرات أخرى في طريقة عرض البيانات المطبقة على التقرير. إذا تم تعطيل عوامل التصفية الثابتة، فترجع false.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
المرتجعات
Promise<boolean>
clearSelectedVisuals(boolean)
مسح المرئيات المحددة غير المبرزة، إذا تم تمرير العلامة، مسح جميع تحديدات المرئيات.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
المعلمات
- clearPopOutState
-
boolean
إذا لم يتم مسح تحديد المرئيات الخاطئة / غير المحددة إذا كانت إحدى المرئيات في حالة انشقاض (في التركيز، تظهر كجدول، تسليط الضوء...)
المرتجعات
Promise<void>
closeAllOverlays()
إغلاق كافة قوائم السياق المفتوحة وتلميحات الأدوات.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
المرتجعات
Promise<void>
configChanged(boolean)
معالجة تغييرات التكوين.
function configChanged(isBootstrap: boolean)
المعلمات
- isBootstrap
-
boolean
deletePage(string)
حذف صفحة من تقرير
// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");
function deletePage(pageName: string): Promise<void>
المعلمات
- pageName
-
string
المرتجعات
Promise<void>
getActivePage()
الحصول على صفحة التقرير النشط.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
المرتجعات
Promise<Page>
getFilters()
يحصل على عوامل التصفية التي يتم تطبيقها على مستوى التقرير.
// Get filters applied at report level
report.getFilters()
.then(filters => {
...
});
function getFilters(): Promise<IFilter[]>
المرتجعات
Promise<IFilter[]>
getId()
يحصل على معرف التقرير من الموقع المتوفر الأول: الخيارات، السمة، تضمين url.
function getId(): string
المرتجعات
string
getPageByName(string)
الحصول على صفحة تقرير باسمها.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
المعلمات
- pageName
-
string
المرتجعات
Promise<Page>
getPages()
الحصول على قائمة الصفحات داخل التقرير.
report.getPages()
.then(pages => {
...
});
function getPages(): Promise<Page[]>
المرتجعات
Promise<Page[]>
getTheme()
الحصول على موضوع التقرير
report.getTheme();
function getTheme(): Promise<IReportTheme>
المرتجعات
Promise<IReportTheme>
getZoom()
إرجاع مستوى التكبير/التصغير الحالي للتقرير.
function getZoom(): Promise<number>
المرتجعات
Promise<number>
isSaved()
يتحقق من حفظ التقرير.
report.isSaved()
function isSaved(): Promise<boolean>
المرتجعات
Promise<boolean>
moveVisual(string, string, number, number, number)
تحديث موضع عنصر تحكم في صفحة.
report.moveVisual(pageName, visualName, x, y, z)
.catch(error => { ... });
function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>
المعلمات
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
المرتجعات
Promise<IHttpPostMessageResponse<void>>
print()
طباعة الصفحة النشطة للتقرير عن طريق استدعاء window.print() على مكون تضمين iframe.
function print(): Promise<void>
المرتجعات
Promise<void>
refresh()
تحديث مصادر البيانات للتقرير.
report.refresh();
function refresh(): Promise<void>
المرتجعات
Promise<void>
removeContextMenuCommand(string, string)
الأمر "إزالة ملحق قائمة السياق".
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- commandName
-
string
- contextMenuTitle
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
removeFilters()
إزالة كافة عوامل التصفية على مستوى التقرير.
report.removeFilters();
function removeFilters(): Promise<IHttpPostMessageResponse<void>>
المرتجعات
Promise<IHttpPostMessageResponse<void>>
removeOptionsMenuCommand(string, string)
الأمر "إزالة ملحق قائمة الخيارات".
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- commandName
-
string
- optionsMenuTitle
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
renamePage(string, string)
إعادة تسمية صفحة من تقرير
// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");
function renamePage(pageName: string, displayName: string): Promise<void>
المعلمات
- pageName
-
string
- displayName
-
string
المرتجعات
Promise<void>
render(IReportEmbedConfiguration | IReportLoadConfiguration)
عرض تقرير محمل مسبقا، باستخدام واجهة برمجة تطبيقات التضمين المرحلي
// Load report
var report = powerbi.load(element, config);
...
// Render report
report.render()
function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>
المعلمات
المرتجعات
Promise<void>
resetPersistentFilters()
إعادة تعيين عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى إلى الحالة الافتراضية للتقرير
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
المرتجعات
Promise<IHttpPostMessageResponse<void>>
resetTheme()
إعادة تعيين النسق الافتراضي للتقرير وتطبيقه
report.resetTheme();
function resetTheme(): Promise<void>
المرتجعات
Promise<void>
resizeActivePage(PageSizeType, number, number)
تحديث حجم الصفحة النشطة في التقرير.
report.resizeActivePage(pageSizeType, width, height)
.catch(error => { ... });
function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>
المعلمات
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
المرتجعات
Promise<IHttpPostMessageResponse<void>>
resizeVisual(string, string, number, number)
تغيير حجم عنصر تحكم في صفحة.
report.resizeVisual(pageName, visualName, width, height)
.catch(error => { ... });
function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>
المعلمات
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
المرتجعات
Promise<IHttpPostMessageResponse<void>>
savePersistentFilters()
حفظ عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى للتقرير
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[])
تعيين عوامل التصفية على مستوى التقرير.
const filters: [
...
];
report.setFilters(filters)
.catch(errors => {
...
});
function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>
المعلمات
- filters
-
IFilter[]
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setPage(string)
تعيين الصفحة النشطة للتقرير.
report.setPage("page2")
.catch(error => { ... });
function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- pageName
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setVisualDisplayState(string, string, VisualContainerDisplayMode)
تحديث حالة العرض لمرئية في صفحة.
report.setVisualDisplayState(pageName, visualName, displayState)
.catch(error => { ... });
function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>
المعلمات
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setZoom(number)
تعيين مستوى التكبير/التصغير للتقرير.
function setZoom(zoomLevel: number): Promise<void>
المعلمات
- zoomLevel
-
number
مستوى التكبير/التصغير لتعيينه
المرتجعات
Promise<void>
switchLayout(LayoutType)
تحديث تخطيط التقرير
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
المعلمات
- layoutType
- LayoutType
المرتجعات
Promise<IHttpPostMessageResponse<void>>
switchMode(string | ViewMode)
تبديل وضع طريقة عرض التقرير.
function switchMode(viewMode: string | ViewMode): Promise<void>
المعلمات
- viewMode
-
string | ViewMode
المرتجعات
Promise<void>
updateFilters(FiltersOperations, IFilter[])
قم بتحديث عوامل التصفية على مستوى التقرير وفقا للعملية: إضافة أو استبدال الكل أو استبداله بالهدف أو إزالته.
report.updateFilters(FiltersOperations.Add, filters)
.catch(errors => { ... });
function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>
المعلمات
- operation
- FiltersOperations
- filters
-
IFilter[]
المرتجعات
Promise<IHttpPostMessageResponse<void>>
updateSettings(ISettings)
يحدث إعدادات الرؤية لجزء التصفية وجزء التنقل في الصفحة.
const newSettings = {
panes: {
filters: {
visible: false
}
}
};
report.updateSettings(newSettings)
.catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
المعلمات
- settings
- ISettings
المرتجعات
Promise<IHttpPostMessageResponse<void>>
تفاصيل الأساليب المتوارثة
exitFullscreen()
يطلب من المستعرض الخروج من وضع ملء الشاشة.
function exitFullscreen()
موروث من Embed.exitFullscreen
fullscreen()
يطلب من المتصفح عرض iframe للمكون في وضع ملء الشاشة.
function fullscreen()
موروث من Embed.fullscreen
getCorrelationId()
احصل على correlationId لجلسة التضمين الحالية.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
المرتجعات
Promise<string>
موروث من Embed.getCorrelationId
off<T>(string, IEventHandler<T>)
إزالة معالج حدث واحد أو أكثر من قائمة المعالجات. إذا تم تحديد مرجع إلى دالة المقبض الموجودة، فقم بإزالة المعالج المحدد. إذا لم يتم تحديد المعالج، فقم بإزالة كافة المعالجات لاسم الحدث المحدد.
report.off('pageChanged')
or
const logHandler = function (event) {
console.log(event);
};
report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)
المعلمات
- eventName
-
string
- handler
-
IEventHandler<T>
موروث من Embed.off
on<T>(string, IEventHandler<T>)
إضافة معالج أحداث لحدث معين.
report.on('pageChanged', (event) => {
console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)
المعلمات
- eventName
-
string
- handler
-
IEventHandler<T>
موروث من Embed.on
reload()
إعادة تحميل التضمين باستخدام التكوين الموجود. على سبيل المثال، بالنسبة للتقارير، يقوم هذا بمسح جميع عوامل التصفية بشكل فعال ويجعل الصفحة الأولى نشطة والتي تحاكي إعادة تعيين تقرير إلى الحالة المحملة.
report.reload();
function reload(): Promise<void>
المرتجعات
Promise<void>
موروث من Embed.reload
removeComponentTabIndex(number)
إزالة سمة tabindex للعنصر
function removeComponentTabIndex(_tabIndex?: number)
المعلمات
- _tabIndex
-
number
موروث من Embed.removeComponentTabIndex
save()
حفظ التقرير.
function save(): Promise<void>
المرتجعات
Promise<void>
موروث من Embed.save
saveAs(ISaveAsParameters)
تقرير SaveAs.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
المعلمات
- saveAsParameters
- ISaveAsParameters
المرتجعات
Promise<void>
موروث من Embed.saveAs
setAccessToken(string)
تعيين accessToken.
function setAccessToken(accessToken: string): Promise<void>
المعلمات
- accessToken
-
string
المرتجعات
Promise<void>
موروث من Embed.setAccessToken
setComponentTabIndex(number)
تعيين سمة tabindex للعنصر
function setComponentTabIndex(tabIndex?: number)
المعلمات
- tabIndex
-
number
موروث من Embed.setComponentTabIndex
setComponentTitle(string)
تعيين عنوان المكون لإمكانية وصول ذوي الاحتياجات الخاصة. في حالة iframes، سيؤدي هذا الأسلوب إلى تغيير عنوان iframe.
function setComponentTitle(title: string)
المعلمات
- title
-
string
موروث من Embed.setComponentTitle