Funcionalidades e propriedades de visuais do Power BICapabilities and properties of Power BI visuals

Você usa as funcionalidades para fornecer informações ao host sobre seu visual.You use capabilities to provide information to the host about your visual. Todas as propriedades no modelo de funcionalidades são optional.All properties on the capabilities model are optional.

Os objetos raiz das funcionalidades do visual são dataRoles, dataViewMappings e assim por diante.The root objects of a visual's capabilities are dataRoles, dataViewMappings, and so on.

{
    "dataRoles": [ ... ],
    "dataViewMappings": [ ... ],
    "objects":  { ... },
    "supportsHighlight": true|false,
    "advancedEditModeSupport": 0|1|2,
    "sorting": { ... }
}

Defina os campos de dados que seu visual espera: dataRolesDefine the data fields that your visual expects: dataRoles

Para definir os campos que podem ser associados aos dados, use dataRoles.To define fields that can be bound to data, you use dataRoles. dataRoles usa uma matriz de objetos DataViewRole, que define todas as propriedades necessárias.dataRoles takes an array of DataViewRole objects, which defines all the required properties.

PropriedadesProperties

  • name: o nome interno deste campo de dados (deve ser exclusivo).name: The internal name of this data field (must be unique).
  • kind: o tipo de campo:kind: The kind of field:
    • Grouping: valores discretos usados para agrupar campos de medida.Grouping: Discrete values that are used to group measure fields.
    • Measure: valores de dados numéricos.Measure: Numeric data values.
    • GroupingOrMeasure: valores que podem ser usados como um agrupamento ou uma medida.GroupingOrMeasure: Values that can be used as either a grouping or a measure.
  • displayName: o nome exibido para o usuário no painel Propriedades.displayName: The name displayed to the user in the Properties pane.
  • description: uma breve descrição do campo (opcional).description: A short description of the field (optional).
  • requiredTypes: o tipo de dados necessário para essa função de dados.requiredTypes: The required type of data for this data role. Os valores que não correspondem são definidos como null (opcional).Values that don't match are set to null (optional).
  • preferredTypes: o tipo de dados preferencial para essa função de dados (opcional).preferredTypes: The preferred type of data for this data role (optional).

Tipos de dados válidos em requiredTypes e preferredTypesValid data types in requiredTypes and preferredTypes

  • bool: um valor boolianobool: A boolean value
  • integer: um valor inteiro (número inteiro)integer: An integer (whole number) value
  • numeric: um valor numériconumeric: A numeric value
  • text: Um valor de textotext: A text value
  • geography: um dado geográficogeography: A geographic data

ExemploExample

"dataRoles": [
    {
        "displayName": "My Category Data",
        "name": "myCategory",
        "kind": "Grouping",
        "requiredTypes": [
            {
                "text": true
            },
            {
                "numeric": true
            },
            {
                "integer": true
            }
        ],
        "preferredTypes": [
            {
                "text": true
            }
        ]
    },
    {
        "displayName": "My Measure Data",
        "name": "myMeasure",
        "kind": "Measure",
        "requiredTypes": [
            {
                "integer": true
            },
            {
                "numeric": true
            }
        ],
        "preferredTypes": [
            {
                "integer": true
            }
        ]
    },
    {
        "displayNameKey": "Visual_Location",
        "name": "Locations",
        "kind": "Measure",
        "displayName": "Locations",
        "requiredTypes": [
            {
                "geography": {
                    "address": true
                }
            },
            {
                "geography": {
                    "city": true
                }
            },
            {
                "geography": {
                    "continent": true
                }
            },
            {
                "geography": {
                    "country": true
                }
            },
            {
                "geography": {
                    "county": true
                }
            },
            {
                "geography": {
                    "place": true
                }
            },
            {
                "geography": {
                    "postalCode": true
                }
            },
            {
                "geography": {
                    "region": true
                }
            },
            {
                "geography": {
                    "stateOrProvince": true
                }
            }
        ]
    }
]

As funções de dados anteriores criariam os campos exibidos na imagem a seguir:The preceding data roles would create the fields that are displayed in the following image:

Campos de função de dados

Defina como você deseja mapear os dados: dataViewMappingsDefine how you want the data mapped: dataViewMappings

Uma propriedade DataViewMappings descreve como as funções de dados se relacionam entre si e permite que você especifique requisitos condicionais para elas.A DataViewMappings property describes how the data roles relate to each other and allows you to specify conditional requirements for the them.

A maioria dos visuais fornece um mapeamento único, mas você pode fornecer vários DataViewMappings.Most visuals provide a single mapping, but you can provide multiple dataViewMappings. Cada mapeamento válido produz uma exibição de dados.Each valid mapping produces a data view.

"dataViewMappings": [
    {
        "conditions": [ ... ],
        "categorical": { ... },
        "table": { ... },
        "single": { ... },
        "matrix": { ... }
    }
]

Para obter mais informações, confira Entender o mapeamento de exibição de dados em visuais do Power BI.For more information, see Understand data view mapping in Power BI visuals.

Definir opções do painel de propriedade: objetosDefine property pane options: objects

Objetos descrevem propriedades personalizáveis associadas ao visual.Objects describe customizable properties that are associated with the visual. Cada objeto pode ter várias propriedades e cada propriedade tem um tipo associado a ela.Each object can have multiple properties, and each property has a type that's associated with it. Os tipos referem-se ao que será essa propriedade.Types refer to what the property will be.

"objects": {
    "myCustomObject": {
        "displayName": "My Object Name",
        "properties": { ... }
    }
}

Para obter mais informações, confira Objetos e propriedades de visuais do Power BI.For more information, see Objects and properties of Power BI visuals.

Manipular realce parcial: supportsHighlightHandle partial highlighting: supportsHighlight

Por padrão, esse valor é definido como false, o que significa que seus valores são automaticamente filtrados quando algo na página é selecionado.By default, this value is set to false, which means that your values are automatically filtered when something on the page is selected. Essa filtragem automática, por sua vez, atualiza seu visual para exibir apenas o valor selecionado.This automatic filtering in turn updates your visual to display only the selected value. Se quiser exibir os dados completos, mas apenas realçar os itens selecionados, precisará definir supportsHighlight como true em capabilities.json.If you want to display the full data but highlight only the selected items, you need to set supportsHighlight to true in your capabilities.json file.

Para obter mais informações, confira Realçar pontos de dados em visuais do Power BI.For more information, see Highlight data points in Power BI visuals.

Gerenciar o modo de edição avançado: advancedEditModeSupportHandle advanced edit mode: advancedEditModeSupport

Um visual pode declarar seu suporte ao modo de edição avançada.A visual can declare its support of advanced edit mode. Por padrão, um visual não dá suporte ao modo de edição avançada, a menos que declarado de outra forma no arquivo capabilities.json.By default, a visual doesn't support advanced edit mode, unless stated otherwise in the capabilities.json file.

Para obter mais informações, confira Modo de edição avançado em visuais do Power BI.For more information, see Advanced edit mode in Power BI visuals.

Opções de classificação de dados para visual: classificaçãoData sorting options for visual: sorting

Um visual pode definir o próprio comportamento de classificação por meio de suas funcionalidades.A visual can define its sorting behavior via its capabilities. Por padrão, um visual não dá suporte à modificação de sua ordem de classificação, a menos que declarado de outra forma no arquivo capabilities.json.By default, a visual doesn't support modifying its sorting order, unless stated otherwise in the capabilities.json file.

Para obter mais informações, confira Opções de classificação para elementos visuais do Power BI.For more information, see Sorting options for Power BI visuals.