시각적 개체의 기능 가져오기

시각적 개체의 기능은 시각화 형식이 허용할 수 있는 데이터 역할입니다. 예를 들어 이 이미지는 시각화 창에 클러스터형 세로 막대형 차트 시각적 기능을 보여줍니다.

보고서 또는 시각적 개체 수준에서 표시되는 데이터를 결정하는 시각적 개체의 기능을 가져옵니다. 기능을 가져오는 데 사용되는 두 API는 모두 IVisualCapabilities반환합니다.

export interface IVisualCapabilities {
  dataRoles?: IVisualDataRole[];
}

dataRoles 시각적 개체가 기대하는 역할 및 해당 역할을 채우는 방법을 정의합니다. 이 데이터는 다음 시각적 데이터 바인딩 API를 사용하는 데 필요합니다. 이러한 각 API는 대상 dataRolename 입력 매개 변수로 예상합니다.

dataRoles IVisualDataRole 인터페이스로 표시됩니다.

interface IVisualDataRole {
    name: string;
    kind: VisualDataRoleKind;
    kindPreference?: VisualDataRoleKindPreference;
    displayName?: string;
    description?: string;
}

• 이름 - VisualDataRole고유 식별자입니다.
• 종류 - 시각적 데이터에 대한 역할의 종류를 나타냅니다.
• kindPreference - 사용할 역할의 종류에 대한 시각적 기본 설정을 나타냅니다.
• displayName - 역할의 표시 이름입니다.
• 설명 - 도구 설명의 텍스트입니다.

보고서에 설치된 기본 제공 시각적 개체와 사용자 지정 시각적 개체 모두에 대한 시각적 메타데이터를 검색할 수 있습니다.

보고서 수준에서 시각적 기능을 가져오는 방법

getVisualCapabilities API를 사용하여 보고서 수준에서 표시되는 시각적 데이터를 찾습니다.

getVisualCapabilities(visualType: string): Promise<models.IVisualCapabilities>

본보기

다음은 보고서 수준에서 시각적 개체를 가로 막대형 차트에서 기능을 찾는 코드 예제입니다.

let capabilities = await report.getVisualCapabilities('barChart');

시각적 수준에서 시각적 기능을 가져오는 방법

getCapabilities API를 사용하여 시각적 수준에서 표시되는 데이터를 결정합니다.

getCapabilities(): Promise<models.IVisualCapabilities>

본보기

다음은 시각적 개체 수준에서 기능을 찾기 위한 코드 예제입니다.

let capabilities = await visual.getCapabilities();

예를 들어 clusteredColumnChart 기능을 가져오면 다음이 반환됩니다.

{
    "dataRoles": [
        {
            "name": "Category",
            "displayName": "Axis",
            "description": "Fields to place on the horizontal or vertical axis",
            "kind": 0
        },
        {
            "name": "Series",
            "displayName": "Legend",
            "description": "The categorical field to show for color",
            "kind": 0
        },
        {
            "name": "Y",
            "displayName": "Values",
            "description": "The numeric amounts to plot",
            "kind": 1
        },
        {
            "name": "Rows",
            "displayName": "Small multiples",
            "description": "Split your visual into multiple, smaller visuals based on your selected fields",
            "kind": 0
        },
        {
            "name": "Tooltips",
            "displayName": "Tooltips",
            "description": "Add additional data fields that people can see in the tooltip when they hover on part of this visualization.",
            "kind": 1
        }
    ]
}

관련 콘텐츠

• 페이지 및 시각적 개체 가져오기
• 데이터 필드 구성
• 보고서 시각적 개체에 대한 메뉴 명령 수정
• 시각적 머리글 숨기거나 표시