Funcionalidades y propiedades de objetos visuales de Power BICapabilities and properties of Power BI visuals

Usará las funcionalidades para proporcionar información al host sobre el objeto visual.You use capabilities to provide information to the host about your visual. Todas las propiedades del modelo de funcionalidades son optional.All properties on the capabilities model are optional.

Los objetos raíz de las funcionalidades de un objeto visual son dataRoles, dataViewMappings, etc.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": { ... }
}

Definición de los campos de datos que espera el objeto visual: dataRolesDefine the data fields that your visual expects: dataRoles

Para definir los campos que se pueden enlazar con los datos, use dataRoles.To define fields that can be bound to data, you use dataRoles. dataRoles toma una matriz de objetos DataViewRole que define todas las propiedades necesarias.dataRoles takes an array of DataViewRole objects, which defines all the required properties.

PropiedadesProperties

  • name: nombre interno de este campo de datos (tiene que ser único).name: The internal name of this data field (must be unique).
  • kind: tipo de campo:kind: The kind of field:
    • Grouping: valores discretos que se usan para agrupar campos de medida.Grouping: Discrete values that are used to group measure fields.
    • Measure: valores de datos numéricos.Measure: Numeric data values.
    • GroupingOrMeasure: valores que se pueden usar como una agrupación o una medida.GroupingOrMeasure: Values that can be used as either a grouping or a measure.
  • displayName: nombre que se muestra al usuario en el panel Propiedades.displayName: The name displayed to the user in the Properties pane.
  • description: descripción breve del campo (opcional).description: A short description of the field (optional).
  • requiredTypes: tipo de datos necesario para este rol de datos.requiredTypes: The required type of data for this data role. Los valores que no coinciden se establecen en null (opcional).Values that don't match are set to null (optional).
  • preferredTypes: tipo de datos preferido para este rol de datos (opcional).preferredTypes: The preferred type of data for this data role (optional).

Tipos de datos válidos en requiredTypes y preferredTypesValid data types in requiredTypes and preferredTypes

  • bool: valor booleano.bool: A boolean value
  • integer: valor entero (número entero).integer: An integer (whole number) value
  • numeric: valor numérico.numeric: A numeric value
  • text: valor de texto.text: A text value
  • geography: datos geográficos.geography: A geographic data

EjemploExample

"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
                }
            }
        ]
    }
]

Los roles de datos anteriores crearían los campos que se muestran en la siguiente imagen:The preceding data roles would create the fields that are displayed in the following image:

Campos de roles de datos

Definición de la forma en que se quieren asignar los datos: dataViewMappingsDefine how you want the data mapped: dataViewMappings

Una propiedad DataViewMappings describe cómo se relacionan los roles de datos entre sí y le permite especificar requisitos condicionales para estos.A DataViewMappings property describes how the data roles relate to each other and allows you to specify conditional requirements for the them.

La mayoría de los objetos visuales proporcionan una sola asignación, pero puede proporcionar varios elementos dataViewMappings.Most visuals provide a single mapping, but you can provide multiple dataViewMappings. Cada asignación válida genera una vista de datos.Each valid mapping produces a data view.

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

Para obtener más información, consulte Información sobre las asignaciones de vistas de datos en objetos visuales de Power BI.For more information, see Understand data view mapping in Power BI visuals.

Definición de las opciones del panel de propiedades: objetosDefine property pane options: objects

Los objetos describen propiedades personalizables que están asociadas al objeto visual.Objects describe customizable properties that are associated with the visual. Cada objeto puede tener varias propiedades y cada propiedad tiene un tipo asociado.Each object can have multiple properties, and each property has a type that's associated with it. Los tipos hacen referencia a lo que será la propiedad.Types refer to what the property will be.

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

Para obtener más información, vea Objetos y propiedades de objetos visuales de Power BI.For more information, see Objects and properties of Power BI visuals.

Control del resaltado parcial: supportsHighlightHandle partial highlighting: supportsHighlight

De forma predeterminada, este valor se establece en false, lo que significa que los valores se filtran automáticamente cuando se selecciona algo en la página.By default, this value is set to false, which means that your values are automatically filtered when something on the page is selected. Este filtrado automático, a su vez, actualiza el objeto visual para mostrar solo el valor seleccionado.This automatic filtering in turn updates your visual to display only the selected value. Si quiere mostrar todos los datos, pero solo resaltar los elementos seleccionados, necesita establecer supportsHighlight en true en el archivo 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 obtener más información, consulte Resaltado de puntos de datos en objetos visuales de Power BI.For more information, see Highlight data points in Power BI visuals.

Control del modo de edición avanzada: advancedEditModeSupportHandle advanced edit mode: advancedEditModeSupport

Un objeto visual puede declarar su compatibilidad con el modo de edición avanzada.A visual can declare its support of advanced edit mode. De forma predeterminada, un objeto visual no admite el modo de edición avanzada, a menos que se indique lo contrario en el archivo capabilities.json.By default, a visual doesn't support advanced edit mode, unless stated otherwise in the capabilities.json file.

Para obtener más información, consulte Modo de edición avanzada en objetos visuales de Power BI.For more information, see Advanced edit mode in Power BI visuals.

Opciones de ordenación de datos para objetos visuales: ordenaciónData sorting options for visual: sorting

Un objeto visual puede definir su comportamiento de ordenación mediante sus funciones.A visual can define its sorting behavior via its capabilities. De forma predeterminada, un objeto visual no permite que se modifique su criterio de ordenación, a menos que se indique lo contrario en el archivo capabilities.json.By default, a visual doesn't support modifying its sorting order, unless stated otherwise in the capabilities.json file.

Para obtener más información, consulte Opciones de ordenación para objetos visuales de Power BI.For more information, see Sorting options for Power BI visuals.