Usar seletores para controlar quais visuais são afetados

Artigo
09/17/2023

Alguns recursos permitem que você use seletores para controlar quais visuais são afetados. O seletor é opcional e, quando não aparece, as configurações são aplicáveis a todos os visuais do relatório.

Recursos compatíveis

Os seletores podem ser usados nos seguintes recursos:

Modificar comandos de menu
Ocultar ou exibir cabeçalhos visuais
Segmentações de dados na carga do relatório

Tipos de seletor

Nome do visual

Aplique as configurações somente para o visual especificado.

selector: {
    $schema: "http://powerbi.com/product/schema#visualSelector",
    visualName: <a visual name> // You can retrieve the name using `getVisuals`
}

Para encontrar um nome visual, você pode usar a getVisuals() API em uma página e obter a propriedade do name visual. O nome do visual é um identificador exclusivo.

Tipo visual

Aplique as configurações a todos os visuais do tipo especificado.

selector: {
    $schema: "http://powerbi.com/product/schema#visualTypeSelector",
    visualType: <a visual type> // You can retrieve the type using `getVisuals`
}

Para encontrar um tipo visual, você pode usar a getVisuals() API em uma página e obter a propriedade do type visual.

Destino da segmentação de dados

Aplique o estado da segmentação somente para as segmentações com o destino especificado.

selector: {
    $schema: "http://powerbi.com/product/schema#slicerTargetSelector",
    target: <target data field>  
}

Exemplos

Configurações do cabeçalho visual

Ocultar todos os cabeçalhos visuais no relatório.

let config = {
    …
    settings: {
        …
        visualSettings: {
            visualHeaders: [
                {
                    settings: {
                        visible: false
                    }
                    /* No selector - Hide visual header for all the visuals in the report */
                }
            ]
        }
    }
};

Ocultar um cabeçalho visual para um visual específico usando o seletor visual.

let config = {
    …
    settings: {
        …
        visualSettings: {
            visualHeaders: [
                {
                    settings: {
                        visible: false
                    }
                    selector: {
                        $schema: "http://powerbi.com/product/schema#visualSelector",
                        visualName: "VisualContainer1",
                    }
                }
            ]
        }
    }
};

As extensões de comando de menu e os comandos internos exibem seletores de suporte.

Adicionando um comando de extensão a um menu de opções visuais específico.

let config = {
    ...
    settings: {
        ...

        // Adding the extension command to the options menu
        extensions: [
            {
                command: {
                    name: "campaign",
                    title: "Start campaign",
                    icon: base64Icon,
                    selector: {
                        $schema: "http://powerbi.com/product/schema#visualSelector",
                        visualName: tableVisualName
                    },
                    extend: {
                        visualOptionsMenu: {
                            title: "Start campaign",
                            menuLocation: models.MenuLocation.Top,
                        }
                    }
                }
            },
        ],
    }
}

Ocultar alguns comandos internos para todos os visuais com table tipo.

let tableSelector = {
    $schema: "http://powerbi.com/product/schema#visualTypeSelector",
    visualType: 'table'
};

let config = {
    ...
    settings: {
        ...
        // Hiding built-in commands on the options menu
        commands: [
            {
                spotlight: {
                    selector: tableSelector,
                    displayOption: models.CommandDisplayOption.Hidden,
                },
                exportData: {
                    selector: tableSelector,
                    displayOption: models.CommandDisplayOption.Hidden,
                },
                seeData: {
                    selector: tableSelector,
                    displayOption: models.CommandDisplayOption.Hidden,
                },
            }
        ]
    },
};

Segmentações de dados na carga

Observação

As segmentações de dados na carga não dão suporte ao seletor de tipo visual

Definir uma segmentação de dados específica por nome

let slicers = [
    {
        selector: {
            $schema: "http://powerbi.com/product/schema#visualSelector",
            visualName: "d1feb8891635af3b335a"
        },
        state: {
            filters: [
            {
                $schema:"http://powerbi.com/product/schema#advanced",
                target: {
                    table: "Store",
                    column: "StoreNumber"
                },
                filterType: models.FilterType.AdvancedFilter,
                logicalOperator: "And",
                conditions: [
                    { operator: "GreaterThanOrEqual", value: 37 },
                    { operator: "LessThanOrEqual", value: 576 }]
            }]
        }
    }
];

embedConfig = {
    slicers: slicers,
    ...
};

Definir segmentações por destino

// We want to slice all slicers with "StoreNumber" column target
let target = {
    table: "Store",
    column: "StoreNumber"
};

let slicers = [
    {
        selector: {
            $schema: "http://powerbi.com/product/schema#slicerTargetSelector",
            target: target
        },
        state: {
            filters: [
            {
                $schema:"http://powerbi.com/product/schema#advanced",
                target: target,
                filterType: models.FilterType.AdvancedFilter,
                logicalOperator: "And",
                conditions: [
                    {operator: "GreaterThanOrEqual", value: 37 },
                    {operator: "LessThanOrEqual", value: 576 }]
            }]
        }
    }
];

embedConfig = {
    slicers: slicers,
    ...
};