@microsoft/sp-property-pane package

Referência

Estrutura do SharePoint painel de propriedades.

Interfaces

IDynamicDataSharedPropertyConfiguration	Configuração relacionada com uma propriedade partilhada.
IDynamicDataSharedPropertyFilters	Filtros de propriedades de dados dinâmicos do painel de propriedades.
IDynamicDataSharedSourceConfiguration	Configuração relacionada com uma origem partilhada.
IDynamicDataSharedSourceFilters	Filtros de origem de dados dinâmicos do painel de propriedades.
IGuidSet	Conjunto de GUIDs que representam um item de lista.
IPopupWindowProps	Adereços de janela de pop-up.
IPropertyPaneButtonProps	Propriedades do botão PropertyPane.
IPropertyPaneCheckboxProps	Propriedades do componente PropertyPane CheckBox.
IPropertyPaneChoiceGroupOption	Propriedades da opção PropertyPane ChoiceGroup.
IPropertyPaneChoiceGroupOptionIconProps	PropertyPane ChoiceGroup ícone props.
IPropertyPaneChoiceGroupProps	Propriedades PropertyPane ChoiceGroup.
IPropertyPaneConditionalGroup	Grupo condicional do painel de propriedades.
IPropertyPaneConfiguration	Definições das configurações da Web Part
IPropertyPaneCustomFieldProps	Propriedades PropertyPane CustomPropertyField.
IPropertyPaneDebounceProperty	Definição de uma propriedade Do Painel de Propriedades, que deve fazer com que o `onPropertyPaneFieldChanged` evento seja debounced.
IPropertyPaneDropdownCalloutProps	PropertyPane propriedades de nota de aviso pendente.
IPropertyPaneDropdownOption	Opções do menu suspenso do PropertyPane.
IPropertyPaneDropdownProps	Propriedades de componente da lista suspensa de PropertyPane.
IPropertyPaneDynamicFieldProps	PropertyPaneDynamicField props.
IPropertyPaneDynamicFieldSetProps	PropertyPane DynamicFieldSet props.
IPropertyPaneDynamicTextFieldProps	`PropertyPaneDynamicData` adereços de componentes.
IPropertyPaneField	Campo PropertyPane.
IPropertyPaneGroup	Campo do PropertyPane. O grupo faz parte do PropertyPanePage.
IPropertyPaneHeadingProps	PropertyPaneHeader componente props.
IPropertyPaneIconPickerProps	PropertyPaneIconPicker componente props
IPropertyPaneLabelProps	Propriedades do componente PropertyPaneLabel.
IPropertyPaneLinkProps	Propriedades do componente PropertyPaneLink
IPropertyPanePage	Interface de PropertyPanePage
IPropertyPanePageHeader	Cabeçalho de PropertyPane. Esse cabeçalho permanece o mesmo para todas as páginas.
IPropertyPaneSliderProps	Propriedades do componente PropertyPaneSliderProps
IPropertyPaneTextFieldProps	Propriedades do componente PropertyPaneTextField.
IPropertyPaneThumbnailPickerProps	PropertyPaneThumbnailPicker componente props
IPropertyPaneToggleProps	Propriedades do componente PropertyPaneToggle
IThumbnailFabricReactIcon	Opções relacionadas com a miniatura do ícone de recursos de infraestrutura.
IThumbnailIconSizeImage	Opções relacionadas com a miniatura da imagem do tamanho do ícone.
IThumbnailImage	Opções relacionadas com a miniatura da imagem.

Aliases de tipo

ImageFit	Os métodos possíveis que podem ser utilizados para se ajustarem à imagem.
IPropertyPaneDynamicFieldFilters	Filtros de campo dinâmico do painel de propriedades, que é uma interseção entre os filtros de origem e de propriedade.
IThumbnail	O tipo de imagem em miniatura que está a ser configurada.
PropertyPaneHeadingLevel	Escreva para os níveis de cabeçalho, h1-h6
ThumbnailType	Tipos de imagem em miniatura suportados.

Enumerações

DynamicDataSharedDepth	Enumerar os possíveis valores de profundidade partilhada da referência de dados dinâmicos.
PopupWindowPosition	A posição da janela de pop-up.
PropertyPaneButtonType	Enumeração para todos os tipos de botão com suporte.
PropertyPaneDropdownOptionType	Especifica o tipo de opção num menu pendente composto por PropertyPaneDropdown().
PropertyPaneFieldType	Enumeração para todos os tipos de campo PropertyPane suportados. Os nomes devem ser consistentes com os do office-ui-fabric-react, tenha cuidado para corrigir as maiúsculas/minúsculas.

Funções

PropertyPaneButton(targetProperty, properties)	Método auxiliar para criar um Botão no PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)	Método auxiliar para criar uma Caixa de seleção no PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)	Método auxiliar para criar um Grupo de seleção no PropertyPane.
PropertyPaneCustomField(properties)	Método auxiliar para criar um campo personalizado no PropertyPane.
PropertyPaneDropdown(targetProperty, properties)	Método auxiliar para criar uma Lista suspensa no PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)	Método auxiliar para criar um widget Dados Dinâmicos no PropertyPane para um campo dinâmico.
PropertyPaneDynamicFieldSet(properties)	Método auxiliar para criar um widget Dados Dinâmicos no Painel de Propriedades para um conjunto de campos dinâmicos com uma origem de dados comum. Estes campos podem possivelmente partilhar a mesma propriedade com base nos filtros associados.
PropertyPaneDynamicTextField(targetProperty, properties)	Método auxiliar para criar um Campo de Texto Dinâmico no PropertyPane.
PropertyPaneHeading(targetProperty, properties)	Método auxiliar para criar um cabeçalho no PropertyPane. Solução temporária enquanto aguarda pela reformulação
PropertyPaneHorizontalRule()	Método auxiliar para criar uma Regra Horizontal no PropertyPane.
PropertyPaneIconPicker(targetProperty, properties)	Método auxiliar para criar um IconPicker no PropertyPane.
PropertyPaneLabel(targetProperty, properties)	Método auxiliar para criar um Rótulo no PropertyPane.
PropertyPaneLink(targetProperty, properties)	Método auxiliar para criar um Link no PropertyPane.
PropertyPaneSlider(targetProperty, properties)	Método auxiliar para criar um Controle Deslizante no PropertyPane.
PropertyPaneTextField(targetProperty, properties)	Método auxiliar para criar um Campo de Texto no PropertyPane.
PropertyPaneThumbnailPicker(targetProperty, properties)	Método auxiliar para criar um ThumbnailPicker no PropertyPane.
PropertyPaneToggle(targetProperty, properties)	Método auxiliar para criar um Botão de Alternância no PropertyPane.

Detalhes da função

PropertyPaneButton(targetProperty, properties)

Método auxiliar para criar um Botão no PropertyPane.

export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o Botão está associado.

properties: IPropertyPaneButtonProps

Propriedades do Botão fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneButtonProps>

PropertyPaneCheckbox(targetProperty, properties)

Método auxiliar para criar uma Caixa de seleção no PropertyPane.

export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual a caixa de seleção está associada.

properties: IPropertyPaneCheckboxProps

Propriedades da Caixa de seleção fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneCheckboxProps>

PropertyPaneChoiceGroup(targetProperty, properties)

Método auxiliar para criar um Grupo de seleção no PropertyPane.

export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o grupo de escolha está associado.

properties: IPropertyPaneChoiceGroupProps

Propriedades do Grupo de Escolha fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

PropertyPaneCustomField(properties)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um campo personalizado no PropertyPane.

export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;

Parâmetros

properties: IPropertyPaneCustomFieldProps

Propriedades de campo personalizadas fortemente digitadas.

Retornos

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Comentários

O objetivo do campo personalizado é ajudar o programador da peça Web a adicionar um controlo personalizado ao PropertyPane. O PropertyPane suporta um anfitrião de tipos de campo incorporados. Embora esta lista satisfaça as exigências da maioria das peças Web, mas existem casos excecionais em que as peças Web têm necessidades especiais e precisam de um controlo especial. O campo personalizado ajuda a preencher essa lacuna.

PropertyPaneDropdown(targetProperty, properties)

Método auxiliar para criar uma Lista suspensa no PropertyPane.

export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual a lista suspensa está associada.

properties: IPropertyPaneDropdownProps

Propriedades da Lista Suspensa fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneDropdownProps>

PropertyPaneDynamicField(targetProperty, properties)

Método auxiliar para criar um widget Dados Dinâmicos no PropertyPane para um campo dinâmico.

export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o widget Dados Dinâmicos está associado.

properties: IPropertyPaneDynamicFieldProps

Retornos

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

PropertyPaneDynamicFieldSet(properties)

Método auxiliar para criar um widget Dados Dinâmicos no Painel de Propriedades para um conjunto de campos dinâmicos com uma origem de dados comum.

Estes campos podem possivelmente partilhar a mesma propriedade com base nos filtros associados.

export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;

Parâmetros

properties: IPropertyPaneDynamicFieldSetProps

Contém entradas e opções, descritas abaixo: entradas – um conjunto de entradas a configurar pelo widget. Cada entrada inclui a propriedade de destino e, opcionalmente, a etiqueta a mostrar. options - Opções que permitem valores personalizados para chamada de retorno, filtros, etc., para o conjunto especificado de campos dinâmicos.

Retornos

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

PropertyPaneDynamicTextField(targetProperty, properties)

Aviso

Essa API foi preterida.

This has been replaced by PropertyPaneDynamicField

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um Campo de Texto Dinâmico no PropertyPane.

export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o campo de texto dinâmico está associado.

properties: IPropertyPaneDynamicTextFieldProps

Propriedades do PropertyPaneDynamicTextField.

Retornos

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

PropertyPaneHeading(targetProperty, properties)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um cabeçalho no PropertyPane. Solução temporária enquanto aguarda pela reformulação

export declare function PropertyPaneHeading(targetProperty: string, properties: IPropertyPaneHeadingProps): IPropertyPaneField<IPropertyPaneHeadingProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o rótulo está associado.

properties: IPropertyPaneHeadingProps

Propriedades do Rótulo fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneHeadingProps>

PropertyPaneHorizontalRule()

Método auxiliar para criar uma Regra Horizontal no PropertyPane.

export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;

Retornos

IPropertyPaneField<void>

PropertyPaneIconPicker(targetProperty, properties)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um IconPicker no PropertyPane.

export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o seletor de ícones está associado.

properties: IPropertyPaneIconPickerProps

Propriedades IconPicker fortemente digitadas.

Retornos

IPropertyPaneField<IPropertyPaneIconPickerProps>

PropertyPaneLabel(targetProperty, properties)

Método auxiliar para criar um Rótulo no PropertyPane.

export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o rótulo está associado.

properties: IPropertyPaneLabelProps

Propriedades do Rótulo fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneLabelProps>

PropertyPaneLink(targetProperty, properties)

Método auxiliar para criar um Link no PropertyPane.

export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o Link está associado.

properties: IPropertyPaneLinkProps

Propriedades do Link fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneLinkProps>

PropertyPaneSlider(targetProperty, properties)

Método auxiliar para criar um Controle Deslizante no PropertyPane.

export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o controle deslizante está associado.

properties: IPropertyPaneSliderProps

Propriedades do Controle Deslizante fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneSliderProps>

PropertyPaneTextField(targetProperty, properties)

Método auxiliar para criar um Campo de Texto no PropertyPane.

export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o campo de texto está associado.

properties: IPropertyPaneTextFieldProps

Propriedades do Campo de Texto fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneTextFieldProps>

PropertyPaneThumbnailPicker(targetProperty, properties)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Método auxiliar para criar um ThumbnailPicker no PropertyPane.

export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o seletor de miniaturas está associado.

properties: IPropertyPaneThumbnailPickerProps

Propriedades ThumbnailPicker fortemente digitadas.

Retornos

IPropertyPaneField<IPropertyPaneThumbnailPickerProps>

PropertyPaneToggle(targetProperty, properties)

Método auxiliar para criar um Botão de Alternância no PropertyPane.

export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;

Parâmetros

targetProperty: string

Propriedade de destino à qual o botão de alternância está associado.

properties: IPropertyPaneToggleProps

Propriedades do Botão de Alternância fortemente tipadas.

Retornos

IPropertyPaneField<IPropertyPaneToggleProps>

Compartilhar via

@microsoft/sp-property-pane package

Interfaces

Aliases de tipo

Enumerações

Funções

Detalhes da função

PropertyPaneButton(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneCheckbox(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneChoiceGroup(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneCustomField(properties)

Parâmetros

Retornos

Comentários

PropertyPaneDropdown(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneDynamicField(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneDynamicFieldSet(properties)

Parâmetros

Retornos

PropertyPaneDynamicTextField(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneHeading(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneHorizontalRule()

Retornos

PropertyPaneIconPicker(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneLabel(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneLink(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneSlider(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneTextField(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneThumbnailPicker(targetProperty, properties)

Parâmetros

Retornos

PropertyPaneToggle(targetProperty, properties)

Parâmetros

Retornos

Recursos adicionais