@microsoft/sp-adaptive-card-extension-base package
Extensões de Cartão Ajustável do SharePoint Framwork
Classes
| AdaptiveCardExtensionContext |
Objeto de contexto da Extensão de Cartão Adaptável. |
| BaseAdaptiveCardExtension |
Classe base para Extensões de Cartão Ajustável. |
| BaseAdaptiveCardQuickView |
Classe base para uma vista rápida de Cartão Ajustável. |
| BaseAdaptiveCardView |
Classe base para uma vista rápida de Cartão Ajustável. |
| BaseBasicCardView |
Classe base para uma vista de Cartão Básico. |
| BaseCardView |
Classe base primitiva para vistas de Cartão. |
| BaseComponentsCardView |
Classe base para vistas de Cartão baseadas em componentes. |
| BaseImageCardView |
Classe base para uma vista cartão de imagem. |
| BasePrimaryTextCardView |
Classe base para uma vista de Cartão de Texto Principal. |
| BaseQuickView |
Classe base para uma vista de Cartão Ajustável. |
| BaseTemplateCardView |
Classe base primitiva para vistas de Cartão baseadas em modelos. |
| BaseView |
Classe base para todas as vistas. |
| BaseWebQuickView |
Classe base para uma vista Rápida da Web. |
| QuickViewNavigator |
Gere uma pilha de vistas de Cartão Ajustável para a Vista rápida. |
| ViewNavigator |
Gere uma pilha de vistas. |
Interfaces
| IActionError | |
| IAdaptiveCardExtensionActionView |
A interface descreve os membros para vistas que podem processar ações AC. |
| IAdaptiveCardExtensionDataView |
A interface define as propriedades da vista que especificam a configuração como propriedade de dados. |
| IAdaptiveCardExtensionImage |
Propriedades da imagem composta numa vista de card. |
| IAdaptiveCardExtensionPropertiesMetadata |
Esta estrutura é utilizada para definir metadados para propriedades da Extensão de Cartão Ajustável como um mapa de cadeia para |
| IAdaptiveCardExtensionPropertyMetadata |
Esta é a estrutura utilizada para valores de mapa em |
| IAttachmentError |
Este objeto representa um erro associado a um único anexo |
| IAxis |
Representa os parâmetros de um eixo num gráfico. |
| IBarChartCardViewConfiguration |
Configuração para um gráfico de barras card vista. |
| IBarChartSeries |
Série para um gráfico de barras. |
| IBaseActionArguments |
O objeto base foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma Ação de Cartão Ajustável é executada. |
| IBaseActionErrorArguments |
O objeto base foi transmitido para IAdaptiveCardExtensionActionView.onActionError quando um Cartão Ajustável OnActionError é executado. |
| IBaseCardDataVisualizationParameters |
Parâmetros base para um componente de visualização de dados. |
| IBaseCardParameters |
Os parâmetros de dados primitivos para cada vista de Cartão. |
| IBaseOnBeforeActionArguments |
Objeto base transmitido para BaseAdaptiveCardExtension.onBeforeAction(). |
| IBaseSeries |
Série genérica para visualização de dados. |
| IBasicCardParameters |
Os parâmetros de dados para BaseBasicCardView. |
| IBasicTextCardViewConfiguration |
Configuração para uma vista de Cartão Básico. |
| ICachedLoadParameters |
Parâmetros utilizados para reidratar a AdaptiveCardExtension durante uma carga em cache |
| ICacheSettings | |
| ICardBarChartConfiguration |
Configuração para um gráfico de barras. |
| ICardBarChartParameters |
Parâmetros para um gráfico de barras. |
| ICardBarConfiguration |
Configuração do componente da área de título da vista de cartão (barra de card). |
| ICardBarParameters |
Parâmetros de componentes da área de título da vista de cartão (barra de card) |
| ICardButton |
Um botão a apresentar numa Vista de Cartão. |
| ICardButtonBase |
Propriedades base para os botões utilizados em diferentes componentes de vista ace card, como Entrada de Texto e Caixa de Pesquisa e Botão de Cartão. |
| ICardButtonConfiguration |
Configuração do componente do botão cartão. |
| ICardButtonParameters |
Parâmetros do componente do botão cartão. |
| ICardComponentParameters |
Base card ver os parâmetros dos componentes. |
| ICardLineChartConfiguration |
Configuração para um gráfico de linhas. |
| ICardLineChartParameters |
Parâmetros para um gráfico de linhas. |
| ICardPieChartConfiguration |
Configuração para um gráfico circular. |
| ICardPieChartParameters |
Parâmetros para um gráfico circular. |
| ICardSearchBoxButton |
Propriedades do botão da caixa de pesquisa. |
| ICardSearchBoxConfiguration |
Configuração do componente da caixa de pesquisa. |
| ICardSearchBoxParameters |
Parâmetros do componente da caixa de pesquisa. Representa uma caixa de pesquisa composta na vista card. |
| ICardSearchFooterConfiguration |
Configuração do componente do rodapé da caixa de pesquisa. |
| ICardSearchFooterParameters |
Parâmetros do componente do rodapé de pesquisa. Representa um contentor com uma imagem (na forma de um círculo) e texto. |
| ICardTextConfiguration |
Configuração do componente de texto. |
| ICardTextInputConfiguration |
Configuração do componente de entrada de texto. |
| ICardTextInputIconButton |
Botão Ícone de introdução de texto. |
| ICardTextInputParameters |
Parâmetros do componente de entrada de texto. |
| ICardTextInputTitleButton |
Botão título da entrada de texto. |
| ICardTextParameters |
Parâmetros do componente de texto. Representa um bloco de texto composto na vista card. |
| ICardViewConfiguration |
Configuração da vista de cartão |
| ICardViewParameters |
Parâmetros de configuração da vista de cartão. A configuração especifica a forma como a vista card é composta. |
| ICartesianChartParameters |
Parâmetros para um componente de gráfico cartesiano com eixos X e Y. |
| IConfirmationDialog |
A opção Caixa de Diálogo de Confirmação que é transmitida através |
| IDataPoint |
Ponto de dados para visualização de dados. |
| IDataVisualizationCardViewConfiguration |
Configuração para uma vista de card datavisualização. |
| IDataVisualizationCardViewParameters |
Os parâmetros da vista card DataVisualization. |
| IExecuteActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma |
| IExecuteCardAction |
Invocar um |
| IExecuteCardParameters |
Parâmetros para a ação Executar card. |
| IExternalLinkActionArguments |
O objeto passou para BaseAdaptiveCardExtension.onBeforeAction() quando uma |
| IExternalLinkCardAction |
Abra uma ligação externa. |
| IExternalLinkParameters |
Parâmetros para abrir uma ligação externa. |
| IFocusParameters |
Interface para dar aos programadores de terceiros a capacidade de determinar que elemento deve receber o foco, quando e com que frequência os conteúdos devem ser lidos. |
| IGetLocationAction |
Interface para a ação Obter Localização Viva |
| IGetLocationActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma Ação Obter localização é executada. |
| IGetLocationActionParameters |
Parâmetros que podem ser fornecidos com a Ação Obter Localização Viva. |
| IGetLocationCardAction |
Invocar um |
| IImageCardParameters |
Os parâmetros de dados para BaseImageCardView. |
| IImageCardViewConfiguration |
Configuração para uma vista de Cartão de Imagem. |
| ILineChartCardViewConfiguration |
Configuração para um gráfico de linhas card vista. |
| ILineChartSeries |
Série para um gráfico de linhas. |
| ILocation |
Interface para coordenadas de localização |
| ILocationActionProvider | |
| ILocationErrorArguments |
Este objeto representa os dados de erro que a ação Localização pode emitir. |
| INotificationArguments |
O objeto passou para BaseAdaptiveCardExtension.onNotificationReceived() quando é recebida uma notificação. |
| INotificationResponse |
O objeto devolvido de BaseAdaptiveCardExtension.onNotificationReceived() se tiver processado a notificação. |
| IPartialMicrosoftTeams |
Fornece acesso ao SDK do Teams e ao contexto do Teams. Apenas fornecido quando a peça Web é carregada no Teams. Atualmente, estamos a fornecer apenas Informações Contextuais Parciais. |
| IPartialSDKs |
Conjunto condicional de SDKs fornecidos pelo SPFx dependentes do ambiente. Atualmente, estamos a fornecer apenas SDKs Parciais. |
| IPartialTeamsContext |
Contexto parcial das equipas |
| IPartialTeamsJs |
Fornece acesso ao SDK do Teams e ao contexto do Teams. Apenas fornecido quando a peça Web é carregada no Teams. |
| IPieChartCardViewConfiguration |
Configuração para um gráfico circular card vista. |
| IPieChartSeries |
Série para um gráfico circular. |
| IPieDataPoint |
Ponto de dados para componentes de visualização de dados Circulares. |
| IPrimaryTextCardParameters |
Os parâmetros de dados para BasePrimaryTextCardView. |
| IPrimaryTextCardViewConfiguration |
Configuração para uma vista cartão de texto principal. |
| IQuickViewActionArguments |
O objeto passou para BaseAdaptiveCardExtension.onBeforeAction() quando uma |
| IQuickViewCardAction |
Abra a vista rápida. |
| IQuickViewNavigator |
Propriedades que descrevem um QuickViewNavigator |
| IQuickViewParameters |
Parâmetros para abrir uma vista Rápida. |
| ISearchCardViewConfiguration |
Configuração para uma vista de Cartão de Pesquisa. |
| ISearchCardViewParameters |
Os parâmetros da vista de card de pesquisa. |
| ISelectMediaAction |
Interface para a nova ação Viva Select Media |
| ISelectMediaActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma |
| ISelectMediaActionErrorArguments |
Este objeto representa os dados devolvidos pela API do selecionador de multimédia nativo. |
| ISelectMediaActionParameters |
Parâmetros que podem ser fornecidos com a Ação De Multimédia Seleção Viva. |
| ISelectMediaAttachment |
Este objeto representa os dados devolvidos pela API do selecionador de multimédia nativo. |
| ISelectMediaCardAction |
Invocar um |
| IShowCardActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma |
| IShowLocationAction |
Interface para a ação Mostrar Localização Viva |
| IShowLocationActionArguments |
O objeto passou para BaseAdaptiveCardExtension.onBeforeAction() quando uma |
| IShowLocationActionParameters |
Parâmetros que podem ser fornecidos com a Ação de Localização Viva Show. |
| IShowLocationCardAction |
Invocar um |
| ISPFxAdaptiveCard |
Esquema de Extensão de Cartão Ajustável SPFx para Cartões Ajustáveis. |
| ISubmitActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma |
| ISubmitCardAction |
Invocar um |
| ISubmitCardParameters |
Parâmetros para submeter card ação. |
| ITextCardViewParameters |
Os parâmetros da vista card com texto ou corpo vazio. |
| ITextInputCardViewConfiguration |
Configuração para uma Vista de Cartão de Entrada de Texto * |
| ITextInputCardViewParameters |
Os parâmetros da vista card com a entrada de texto no corpo. |
| ITextInputImageCardViewConfiguration |
Configuração para uma Vista de Cartão de Entrada de Texto * |
| IViewNavigator |
Propriedades que descrevem um ViewNavigator |
Aliases de tipo
| BarChartData |
Tipo de utilitário para definir os tipos de dados válidos que podem ser utilizados numa visualização de dados de gráfico de barras. |
| BaseOnBeforeActionArguments |
Tipo de base para impor o tipo correto de argumentos transmitidos para BaseAdaptiveCardExtension.onBeforeAction(). |
| CardComponentConfiguration |
Configuração do componente base. |
| CardComponentEventNames |
Lista de todos os eventos suportados por componentes. |
| CardComponentName |
Nomes dos componentes permitidos numa vista de card. |
| CardDataVisualizationKind |
Visualizações de dados suportadas para compor na vista de card. |
| CardSearchBoxEventNames |
Nomes de eventos suportados pelo componente da caixa de pesquisa. |
| CardSize |
Tamanho da vista Cartão. |
| CardTextInputEventNames |
Nomes de eventos suportados pelo componente de entrada de texto. |
| CardViewActionsFooterConfiguration |
A configuração de rodapé apenas de ações para a vista de card. |
| CardViewActionsFooterParameters |
Os parâmetros de rodapé apenas de ações para a vista de card. |
| ComponentsCardViewParameters |
Tipo de configuração de vista de cartão. |
| DeviceContext |
|
| GenericCardViewFooterConfiguration |
A configuração do rodapé para os modelos de vista de card Genérico. |
| GenericCardViewFooterParameters |
Os parâmetros de rodapé para os modelos de vista de card Genérico. Pode conter 0 a 2 botões ou uma única entrada de texto. |
| IActionArguments |
O objeto foi transmitido para IAdaptiveCardExtensionActionView.onAction quando uma Ação de Cartão Ajustável é executada. |
| IActionErrorArguments |
O objeto passou para IAdaptiveCardExtensionActionView.onActionError quando ocorreu um erro ao executar a Ação de Cartão Adaptável. |
| IAdaptiveCardExtensionIcon |
Ícone de vista de cartão. |
| ICardAction |
Tipo de processador para quando um botão é premido. |
| IOnBeforeActionArguments |
O objeto passou para BaseAdaptiveCardExtension.onBeforeAction() quando uma Ação de Cartão Ajustável é executada. |
| LineChartData |
Tipo de utilitário para definir os tipos de dados válidos que podem ser utilizados numa visualização de dados de gráfico de linhas. |
| MaxThreeTuple |
Tipo de utilitário para impor uma cadeia de identificação com um comprimento máximo de 3. |
| RenderType |
|
| SupportedBarChartDataTypes |
Conjunto de tipos suportados para os dados utilizados com a visualização de dados do gráfico de barras. |
| SupportedLineChartDataTypes |
Conjunto de tipos suportados para os dados utilizados com a visualização de dados do gráfico de linhas. |
Enumerações
| MediaType |
Valor de enumeração para especificar o tipo de suporte de dados. |
Funções
| Bar |
Método auxiliar para criar um gráfico de barras card vista com dados numéricos. |
| Bar |
Método auxiliar para criar um gráfico de barras card vista com dados de cadeia. |
| Bar |
Método auxiliar para criar um gráfico de barras card vista com dados de data. |
| Basic |
Método auxiliar para criar uma Vista de Cartão Básica. |
| Image |
Método auxiliar para criar uma Vista de Cartão de Imagem. |
| Line |
Método auxiliar para criar um gráfico de linhas card vista com dados numéricos. |
| Line |
Método auxiliar para criar um gráfico de linhas card vista com dados de data. |
| Pie |
Método auxiliar para criar um gráfico circular card vista |
| Primary |
Método auxiliar para criar uma Vista de Cartão de Texto Principal. |
| Search |
Método auxiliar para criar uma Vista de Cartão de Pesquisa. |
| Text |
Método auxiliar para criar uma Vista de Cartão de Entrada de Texto. |
| Text |
Método auxiliar para criar uma Entrada de Texto com Vista de Cartão de Imagem. |
Detalhes da função
BarChartCardView(configuration)
Método auxiliar para criar um gráfico de barras card vista com dados numéricos.
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<number>): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
-
IBarChartCardViewConfiguration<number>
Retornos
BarChartCardView(configuration)
Método auxiliar para criar um gráfico de barras card vista com dados de cadeia.
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<string>): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
-
IBarChartCardViewConfiguration<string>
Retornos
BarChartCardView(configuration)
Método auxiliar para criar um gráfico de barras card vista com dados de data.
export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<Date>): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
Retornos
BasicCardView(configuration)
Método auxiliar para criar uma Vista de Cartão Básica.
export declare function BasicCardView(configuration: IBasicTextCardViewConfiguration): ITextCardViewParameters;
Parâmetros
- configuration
- IBasicTextCardViewConfiguration
configuração da vista de card básica.
Retornos
ImageCardView(configuration)
Método auxiliar para criar uma Vista de Cartão de Imagem.
export declare function ImageCardView(configuration: IImageCardViewConfiguration): ITextCardViewParameters;
Parâmetros
- configuration
- IImageCardViewConfiguration
configuração da vista de card de imagens.
Retornos
LineChartCardView(configuration)
Método auxiliar para criar um gráfico de linhas card vista com dados numéricos.
export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<number>): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
-
ILineChartCardViewConfiguration<number>
Retornos
LineChartCardView(configuration)
Método auxiliar para criar um gráfico de linhas card vista com dados de data.
export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<Date>): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
Retornos
PieChartCardView(configuration)
Método auxiliar para criar um gráfico circular card vista
export declare function PieChartCardView(configuration: IPieChartCardViewConfiguration): IDataVisualizationCardViewParameters;
Parâmetros
- configuration
- IPieChartCardViewConfiguration
gráfico circular card configuração da vista.
Retornos
gráfico circular card ver parâmetros.
PrimaryTextCardView(configuration)
Método auxiliar para criar uma Vista de Cartão de Texto Principal.
export declare function PrimaryTextCardView(configuration: IPrimaryTextCardViewConfiguration): ITextCardViewParameters;
Parâmetros
- configuration
- IPrimaryTextCardViewConfiguration
texto primário card configuração da vista.
Retornos
SearchCardView(configuration)
Método auxiliar para criar uma Vista de Cartão de Pesquisa.
export declare function SearchCardView(configuration: ISearchCardViewConfiguration): ISearchCardViewParameters;
Parâmetros
- configuration
- ISearchCardViewConfiguration
procurar card ver a configuração.
Retornos
TextInputCardView(configuration)
Método auxiliar para criar uma Vista de Cartão de Entrada de Texto.
export declare function TextInputCardView(configuration: ITextInputCardViewConfiguration): ITextInputCardViewParameters;
Parâmetros
- configuration
- ITextInputCardViewConfiguration
card configuração da vista de entrada de texto.
Retornos
TextInputImageCardView(configuration)
Método auxiliar para criar uma Entrada de Texto com Vista de Cartão de Imagem.
export declare function TextInputImageCardView(configuration: ITextInputImageCardViewConfiguration): ITextInputCardViewParameters;
Parâmetros
- configuration
- ITextInputImageCardViewConfiguration
introdução de texto com a configuração da vista de card de imagem.