Visual class
Power BI Visual 포함 구성 요소
- Extends
상속된 속성
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에서 보고서 ID를 가져옵니다. |
get |
보고서 페이지를 이름으로 가져옵니다.
|
get |
보고서의 테마 가져오기
|
get |
보고서의 현재 확대/축소 수준을 반환합니다. |
is |
보고서가 저장되었는지 확인합니다.
|
move |
페이지에서 시각적 개체의 위치를 업데이트.
|
off<T>(string, IEvent |
처리기 목록에서 하나 이상의 이벤트 처리기를 제거합니다. 기존 핸들 함수에 대한 참조가 지정된 경우 특정 처리기를 제거합니다. 처리기를 지정하지 않으면 지정된 이벤트 이름에 대한 모든 처리기를 제거합니다.
|
on<T>(string, IEvent |
특정 이벤트에 대한 이벤트 처리기를 추가합니다.
|
print() | embed iframe 구성 요소에서 를 호출하여 |
refresh() | 보고서의 데이터 원본을 새로 고칩니다.
|
reload() | 기존 구성을 사용하여 포함을 다시 로드합니다. 예를 들어 보고서의 경우 모든 필터를 효과적으로 지우고 첫 번째 페이지를 활성화하여 보고서를 로드된 상태로 다시 설정하는 것을 시뮬레이트합니다.
|
remove |
요소의 tabindex 특성을 제거합니다. |
remove |
상황에 맞는 메뉴 확장 명령을 제거합니다.
|
remove |
옵션 메뉴 확장 명령을 제거합니다.
|
rename |
보고서에서 페이지 이름 바꾸기
|
reset |
사용자의 필터, 슬라이서 및 기타 데이터 뷰 변경 내용을 보고서의 기본 상태로 다시 설정합니다.
|
reset |
보고서의 기본 테마 다시 설정 및 적용
|
resize |
보고서의 활성 페이지 크기를 업데이트.
|
resize |
페이지의 시각적 개체 크기를 조정합니다.
|
save() | 보고서를 저장합니다. |
save |
SaveAs 보고서. |
save |
보고서의 사용자 필터, 슬라이서 및 기타 데이터 뷰 변경 내용 저장
|
set |
accessToken을 설정합니다. |
set |
요소의 tabindex 특성을 설정합니다. |
set |
접근성을 위해 구성 요소 제목을 설정합니다. iframe의 경우 이 메서드는 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()
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>>
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>
Report.addPage에서 상속됨
applyTheme(IReportTheme)
보고서에 테마 적용
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
매개 변수
- theme
- IReportTheme
반환
Promise<void>
Report.applyTheme에서 상속됨
arePersistentFiltersApplied()
보고서에 적용된 사용자의 필터, 슬라이서 또는 기타 데이터 뷰 변경 내용이 있는 경우 를 반환합니다. 영구 필터를 사용하지 않도록 설정하면 는 false를 반환합니다.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
반환
Promise<boolean>
clearSelectedVisuals(boolean)
선택한 시각적 개체를 지우지 않으면 플래그가 전달되면 모든 시각적 개체 선택 항목이 지워집니다.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
매개 변수
- clearPopOutState
-
boolean
false/undefined 시각적 개체 중 하나가 팝아웃 상태인 경우 선택 취소되지 않는 경우(포커스에서 테이블로 표시, 스포트라이트...)
반환
Promise<void>
closeAllOverlays()
열려 있는 모든 상황에 맞는 메뉴 및 도구 설명을 닫습니다.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
반환
Promise<void>
Report.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()
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에서 보고서 ID를 가져옵니다.
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>
Report.getTheme에서 상속됨
getZoom()
보고서의 현재 확대/축소 수준을 반환합니다.
function getZoom(): Promise<number>
반환
Promise<number>
Report.getZoom에서 상속됨
isSaved()
보고서가 저장되었는지 확인합니다.
report.isSaved()
function isSaved(): Promise<boolean>
반환
Promise<boolean>
Report.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>>
Report.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>
Report.on에서 상속됨
print()
embed iframe 구성 요소에서 를 호출하여 window.print()
보고서의 활성 페이지를 인쇄합니다.
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
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>>
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>
Report.renamePage에서 상속됨
resetPersistentFilters()
사용자의 필터, 슬라이서 및 기타 데이터 뷰 변경 내용을 보고서의 기본 상태로 다시 설정합니다.
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
반환
Promise<IHttpPostMessageResponse<void>>
resetTheme()
보고서의 기본 테마 다시 설정 및 적용
report.resetTheme();
function resetTheme(): Promise<void>
반환
Promise<void>
Report.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>>
setAccessToken(string)
accessToken을 설정합니다.
function setAccessToken(accessToken: string): Promise<void>
매개 변수
- accessToken
-
string
반환
Promise<void>
Report.setAccessToken에서 상속됨
setComponentTabIndex(number)
요소의 tabindex 특성을 설정합니다.
function setComponentTabIndex(tabIndex?: number)
매개 변수
- tabIndex
-
number
setComponentTitle(string)
접근성을 위해 구성 요소 제목을 설정합니다. iframe의 경우 이 메서드는 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>>
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에서 상속됨