Visual class
مكون تضمين Power BI Visual
- يمتد
الخصائص الموروثة
| bookmarks |
الأساليب
| get |
يحصل على عوامل التصفية التي يتم تطبيقها على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
|
| get |
الحصول على قائمة الصفحات داخل التقرير - غير معتمدة في المرئيات |
| get |
يحصل على كائن الواصف المرئي المضمن الذي يحتوي على الاسم المرئي والنوع وما إلى ذلك.
|
| remove |
إزالة كافة عوامل التصفية من مستوى عامل التصفية الحالي. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
|
| set |
تعيين عوامل التصفية على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
|
| set |
تعيين الصفحة النشطة للتقرير - غير معتمدة في المرئيات |
| update |
تحديث عوامل التصفية على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
|
الأساليب المتوارثة
| add |
الأمر إضافة ملحق قائمة السياق.
|
| add |
الأمر إضافة ملحق قائمة خيارات.
|
| add |
إضافة صفحة فارغة إلى التقرير
|
| apply |
تطبيق نسق على التقرير
|
| are |
إرجاع إذا كانت هناك عوامل تصفية للمستخدم أو مقسمات طرق عرض أو تغييرات أخرى في طريقة عرض البيانات المطبقة على التقرير. إذا تم تعطيل عوامل التصفية الثابتة، فترجع false.
|
| clear |
مسح المرئيات المحددة غير المبرزة، إذا تم تمرير العلامة، مسح جميع تحديدات المرئيات.
|
| close |
إغلاق كافة قوائم السياق المفتوحة وتلميحات الأدوات.
|
| config |
معالجة تغييرات التكوين. |
| delete |
حذف صفحة من تقرير
|
| exit |
يطلب من المستعرض الخروج من وضع ملء الشاشة. |
| fullscreen() | يطلب من المتصفح عرض iframe للمكون في وضع ملء الشاشة. |
| get |
الحصول على صفحة التقرير النشط.
|
| get |
احصل على correlationId لجلسة التضمين الحالية.
|
| get |
يحصل على معرف التقرير من الموقع المتوفر الأول: الخيارات، السمة، تضمين url. |
| get |
الحصول على صفحة تقرير باسمها.
|
| get |
الحصول على موضوع التقرير
|
| get |
إرجاع مستوى التكبير/التصغير الحالي للتقرير. |
| is |
يتحقق من حفظ التقرير.
|
| move |
تحديث موضع عنصر تحكم في صفحة.
|
| off<T>(string, IEvent |
إزالة معالج حدث واحد أو أكثر من قائمة المعالجات. إذا تم تحديد مرجع إلى دالة المقبض الموجودة، فقم بإزالة المعالج المحدد. إذا لم يتم تحديد المعالج، فقم بإزالة كافة المعالجات لاسم الحدث المحدد.
|
| on<T>(string, IEvent |
إضافة معالج أحداث لحدث معين.
|
| print() | طباعة الصفحة النشطة للتقرير عن طريق استدعاء |
| refresh() | تحديث مصادر البيانات للتقرير.
|
| reload() | إعادة تحميل التضمين باستخدام التكوين الموجود. على سبيل المثال، بالنسبة للتقارير، يقوم هذا بمسح جميع عوامل التصفية بشكل فعال ويجعل الصفحة الأولى نشطة والتي تحاكي إعادة تعيين تقرير إلى الحالة المحملة.
|
| remove |
إزالة سمة tabindex للعنصر |
| remove |
الأمر "إزالة ملحق قائمة السياق".
|
| remove |
الأمر "إزالة ملحق قائمة الخيارات".
|
| rename |
إعادة تسمية صفحة من تقرير
|
| reset |
إعادة تعيين عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى إلى الحالة الافتراضية للتقرير
|
| reset |
إعادة تعيين النسق الافتراضي للتقرير وتطبيقه
|
| resize |
تحديث حجم الصفحة النشطة في التقرير.
|
| resize |
تغيير حجم عنصر تحكم في صفحة.
|
| save() | حفظ التقرير. |
| save |
تقرير SaveAs. |
| save |
حفظ عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى للتقرير
|
| set |
تعيين accessToken. |
| set |
تعيين سمة tabindex للعنصر |
| set |
تعيين عنوان المكون لإمكانية وصول ذوي الاحتياجات الخاصة. في حالة iframes، سيؤدي هذا الأسلوب إلى تغيير عنوان iframe. |
| set |
تحديث حالة العرض لمرئية في صفحة.
|
| set |
تعيين مستوى التكبير/التصغير للتقرير. |
| switch |
تحديث تخطيط التقرير
|
| switch |
تبديل وضع طريقة عرض التقرير. |
| update |
يحدث إعدادات الرؤية لجزء التصفية وجزء التنقل في الصفحة.
|
تفاصيل الخاصية الموروثة
bookmarksManager
تفاصيل الأسلوب
getFilters(FiltersLevel)
يحصل على عوامل التصفية التي يتم تطبيقها على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
المعلمات
- filtersLevel
- FiltersLevel
المرتجعات
Promise<IFilter[]>
getPages()
الحصول على قائمة الصفحات داخل التقرير - غير معتمدة في المرئيات
function getPages(): Promise<Page[]>
المرتجعات
Promise<Page[]>
getVisualDescriptor()
يحصل على كائن الواصف المرئي المضمن الذي يحتوي على الاسم المرئي والنوع وما إلى ذلك.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
المرتجعات
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
إزالة كافة عوامل التصفية من مستوى عامل التصفية الحالي. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
المعلمات
- filtersLevel
- FiltersLevel
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
تعيين عوامل التصفية على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
المعلمات
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
المرتجعات
Promise<IHttpPostMessageResponse<void>>
setPage(string)
تعيين الصفحة النشطة للتقرير - غير معتمدة في المرئيات
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- _pageName
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
تحديث عوامل التصفية على مستوى عامل التصفية. مستوى عامل التصفية الافتراضي هو المستوى المرئي.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
المعلمات
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
المرتجعات
Promise<IHttpPostMessageResponse<void>>
تفاصيل الأساليب المتوارثة
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>>
موروث منReport.addContextMenuCommand
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>>
موروث منReport.addOptionsMenuCommand
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>
موروث منReport.addPage
applyTheme(IReportTheme)
تطبيق نسق على التقرير
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
المعلمات
- theme
- IReportTheme
المرتجعات
Promise<void>
موروث من تقرير.applyTheme
arePersistentFiltersApplied()
إرجاع إذا كانت هناك عوامل تصفية للمستخدم أو مقسمات طرق عرض أو تغييرات أخرى في طريقة عرض البيانات المطبقة على التقرير. إذا تم تعطيل عوامل التصفية الثابتة، فترجع false.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
المرتجعات
Promise<boolean>
موروث من تقرير.arePersistentFiltersApplied
clearSelectedVisuals(boolean)
مسح المرئيات المحددة غير المبرزة، إذا تم تمرير العلامة، مسح جميع تحديدات المرئيات.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
المعلمات
- clearPopOutState
-
boolean
إذا لم يتم مسح تحديد المرئيات الخاطئة / غير المحددة إذا كانت إحدى المرئيات في حالة انشقاض (في التركيز، تظهر كجدول، تسليط الضوء...)
المرتجعات
Promise<void>
موروث من تقرير.clearSelectedVisuals
closeAllOverlays()
إغلاق كافة قوائم السياق المفتوحة وتلميحات الأدوات.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
المرتجعات
Promise<void>
موروثة من تقرير.closeAllOverlays
configChanged(boolean)
معالجة تغييرات التكوين.
function configChanged(isBootstrap: boolean)
المعلمات
- isBootstrap
-
boolean
موروث منReport.configChanged
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>
موروث منReport.deletePage
exitFullscreen()
fullscreen()
يطلب من المتصفح عرض iframe للمكون في وضع ملء الشاشة.
function fullscreen()
موروثة منReport.fullscreen
getActivePage()
الحصول على صفحة التقرير النشط.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
المرتجعات
Promise<Page>
موروث منReport.getActivePage
getCorrelationId()
احصل على correlationId لجلسة التضمين الحالية.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
المرتجعات
Promise<string>
موروث منReport.getCorrelationId
getId()
يحصل على معرف التقرير من الموقع المتوفر الأول: الخيارات، السمة، تضمين url.
function getId(): string
المرتجعات
string
موروث منReport.getId
getPageByName(string)
الحصول على صفحة تقرير باسمها.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
المعلمات
- pageName
-
string
المرتجعات
Promise<Page>
موروث منReport.getPageByName
getTheme()
الحصول على موضوع التقرير
report.getTheme();
function getTheme(): Promise<IReportTheme>
المرتجعات
Promise<IReportTheme>
موروث من تقرير.getTheme
getZoom()
إرجاع مستوى التكبير/التصغير الحالي للتقرير.
function getZoom(): Promise<number>
المرتجعات
Promise<number>
موروث منReport.getZoom
isSaved()
يتحقق من حفظ التقرير.
report.isSaved()
function isSaved(): Promise<boolean>
المرتجعات
Promise<boolean>
موروث من تقرير.isSaved
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>>
موروث من تقرير.moveVisual
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>
موروث منReport.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>
موروث من تقرير.on
print()
طباعة الصفحة النشطة للتقرير عن طريق استدعاء window.print() على مكون تضمين iframe.
function print(): Promise<void>
المرتجعات
Promise<void>
موروث منReport.print
refresh()
تحديث مصادر البيانات للتقرير.
report.refresh();
function refresh(): Promise<void>
المرتجعات
Promise<void>
موروث منReport.refresh
reload()
إعادة تحميل التضمين باستخدام التكوين الموجود. على سبيل المثال، بالنسبة للتقارير، يقوم هذا بمسح جميع عوامل التصفية بشكل فعال ويجعل الصفحة الأولى نشطة والتي تحاكي إعادة تعيين تقرير إلى الحالة المحملة.
report.reload();
function reload(): Promise<void>
المرتجعات
Promise<void>
موروث منReport.reload
removeComponentTabIndex(number)
إزالة سمة tabindex للعنصر
function removeComponentTabIndex(_tabIndex?: number)
المعلمات
- _tabIndex
-
number
موروث من تقرير.removeComponentTabIndex
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>>
موروث من تقرير.removeContextMenuCommand
removeOptionsMenuCommand(string, string)
الأمر "إزالة ملحق قائمة الخيارات".
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
المعلمات
- commandName
-
string
- optionsMenuTitle
-
string
المرتجعات
Promise<IHttpPostMessageResponse<void>>
موروث من تقرير.removeOptionsMenuCommand
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>
موروث منReport.renamePage
resetPersistentFilters()
إعادة تعيين عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى إلى الحالة الافتراضية للتقرير
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
المرتجعات
Promise<IHttpPostMessageResponse<void>>
موروث من تقرير.resetPersistentFilters
resetTheme()
إعادة تعيين النسق الافتراضي للتقرير وتطبيقه
report.resetTheme();
function resetTheme(): Promise<void>
المرتجعات
Promise<void>
موروث من تقرير.resetTheme
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>>
موروث منReport.resizeActivePage
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>>
موروث منReport.resizeVisual
save()
saveAs(ISaveAsParameters)
تقرير SaveAs.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
المعلمات
- saveAsParameters
- ISaveAsParameters
المرتجعات
Promise<void>
موروث منReport.saveAs
savePersistentFilters()
حفظ عوامل تصفية المستخدم ومقسمات طرق العرض وتغييرات طريقة عرض البيانات الأخرى للتقرير
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
المرتجعات
Promise<IHttpPostMessageResponse<void>>
موروث من تقرير.savePersistentFilters
setAccessToken(string)
تعيين accessToken.
function setAccessToken(accessToken: string): Promise<void>
المعلمات
- accessToken
-
string
المرتجعات
Promise<void>
موروث منReport.setAccessToken
setComponentTabIndex(number)
تعيين سمة tabindex للعنصر
function setComponentTabIndex(tabIndex?: number)
المعلمات
- tabIndex
-
number
موروث منReport.setComponentTabIndex
setComponentTitle(string)
تعيين عنوان المكون لإمكانية وصول ذوي الاحتياجات الخاصة. في حالة iframes، سيؤدي هذا الأسلوب إلى تغيير عنوان iframe.
function setComponentTitle(title: string)
المعلمات
- title
-
string
موروث منReport.setComponentTitle
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>>
موروث منReport.setVisualDisplayState
setZoom(number)
تعيين مستوى التكبير/التصغير للتقرير.
function setZoom(zoomLevel: number): Promise<void>
المعلمات
- zoomLevel
-
number
مستوى التكبير/التصغير لتعيينه
المرتجعات
Promise<void>
موروث منReport.setZoom
switchLayout(LayoutType)
تحديث تخطيط التقرير
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
المعلمات
- layoutType
- LayoutType
المرتجعات
Promise<IHttpPostMessageResponse<void>>
موروث منReport.switchLayout
switchMode(string | ViewMode)
تبديل وضع طريقة عرض التقرير.
function switchMode(viewMode: string | ViewMode): Promise<void>
المعلمات
- viewMode
-
string | ViewMode
المرتجعات
Promise<void>
موروث منReport.switchMode
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>>
موروث منReport.updateSettings