Поделиться через

@microsoft/sp-adaptive-card-extension-base package

Расширения адаптивной карточки Framwork для SharePoint

Классы

AdaptiveCardExtensionContext

Объект контекста расширения адаптивной карточки.
BaseAdaptiveCardExtension

Базовый класс для расширений адаптивных карточек.
BaseAdaptiveCardQuickView

Базовый класс для быстрого представления адаптивной карточки.
BaseAdaptiveCardView

Базовый класс для быстрого представления адаптивной карточки.
BaseBasicCardView

Базовый класс для представления "Базовая карточка".
BaseCardView

Примитивный базовый класс для представлений Card.
BaseComponentsCardView

Базовый класс для представлений карточек на основе компонентов.
BaseImageCardView

Базовый класс для представления карточки изображения.
BasePrimaryTextCardView

Базовый класс для представления основной текстовой карточки.
BaseQuickView

Базовый класс для представления адаптивной карточки.
BaseTemplateCardView

Примитивный базовый класс для представлений карточек на основе шаблонов.
BaseView

Базовый класс для всех представлений.
BaseWebQuickView

Базовый класс для быстрого веб-представления.
QuickViewNavigator

Управляет стеком представлений адаптивных карточек для быстрого представления.
ViewNavigator

Управляет стеком представлений.

Интерфейсы

IActionError
IAdaptiveCardExtensionActionView

Интерфейс описывает элементы для представлений, которые могут обрабатывать действия ac.
IAdaptiveCardExtensionDataView

Интерфейс определяет свойства для представления, которые указывают конфигурацию в качестве свойства данных.
IAdaptiveCardExtensionImage

Свойства изображения, отображаемого в представлении карта.
IAdaptiveCardExtensionPropertiesMetadata

Эта структура используется для определения метаданных свойств расширения адаптивной карточки в виде сопоставления строк с IAdaptiveCardExtensionPropertiesMetadata
IAdaptiveCardExtensionPropertyMetadata

Это структура, используемая для значений карты в IAdaptiveCardExtensionPropertiesMetadata.
IAttachmentError

Этот объект представляет ошибку, связанную с одним вложением
IAxis

Представляет параметры для оси на диаграмме.
IBarChartCardViewConfiguration

Конфигурация для линейчатой диаграммы карта представлении.
IBarChartSeries

Ряды для линейчатой диаграммы.
IBaseActionArguments

Базовый объект передается в IAdaptiveCardExtensionActionView.onAction при выполнении действия адаптивной карточки.
IBaseActionErrorArguments

Базовый объект передается в IAdaptiveCardExtensionActionView.onActionError при выполнении адаптивной карточки OnActionError.
IBaseCardDataVisualizationParameters

Базовые параметры для компонента визуализации данных.
IBaseCardParameters

Примитивные параметры данных для каждого представления карточки.
IBaseOnBeforeActionArguments

Базовый объект передается в BaseAdaptiveCardExtension.onBeforeAction().
IBaseSeries

Универсальный ряд для визуализации данных.
IBasicCardParameters

Параметры данных для BaseBasicCardView.
IBasicTextCardViewConfiguration

Настройка представления "Базовая карточка".
ICachedLoadParameters

Параметры, используемые для восстановления AdaptiveCardExtension во время кэширования нагрузки
ICacheSettings
ICardBarChartConfiguration

Конфигурация линейчатой диаграммы.
ICardBarChartParameters

Параметры линейчатой диаграммы.
ICardBarConfiguration

Конфигурация компонента области заголовка представления карточки (карта панели).
ICardBarParameters

Параметры компонента области заголовка представления карточки (карта панели)
ICardButton

Кнопка, отображаемая в представлении карточки.
ICardButtonBase

Базовые свойства для кнопок, используемых в разных компонентах ACE карта представления, таких как текстовый ввод, поле поиска и кнопка карточки.
ICardButtonConfiguration

Конфигурация компонента кнопки карточки.
ICardButtonParameters

Параметры компонента кнопки карточки.
ICardComponentParameters

Базовый карта просмотр параметров компонента.
ICardLineChartConfiguration

Конфигурация для графики.
ICardLineChartParameters

Параметры для графики.
ICardPieChartConfiguration

Конфигурация круговой диаграммы.
ICardPieChartParameters

Параметры круговой диаграммы.
ICardSearchBoxButton

Свойства кнопки поля поиска.
ICardSearchBoxConfiguration

Конфигурация компонента поля поиска.
ICardSearchBoxParameters

Параметры компонента поля поиска. Представляет поле поиска, отображаемое в представлении карта.
ICardSearchFooterConfiguration

Конфигурация компонента нижнего колонтитула поля поиска.
ICardSearchFooterParameters

Поиск параметров компонента нижнего колонтитула. Представляет контейнер с изображением (в форме круга) и текстом.
ICardTextConfiguration

Конфигурация компонента текста.
ICardTextInputConfiguration

Конфигурация компонента текстового ввода.
ICardTextInputIconButton

Кнопка "Значок ввода текста".
ICardTextInputParameters

Параметры компонента текстового ввода.
ICardTextInputTitleButton

Кнопка заголовка текстового ввода.
ICardTextParameters

Параметры компонента текста. Представляет текстовый блок, отображаемый в представлении карта.
ICardViewConfiguration

Конфигурация представления карточки
ICardViewParameters

Параметры конфигурации представления карточки. Конфигурация указывает, как отображается представление карта.
ICartesianChartParameters

Параметры для компонента декартовой диаграммы с осями X и Y.
IConfirmationDialog

Выполняется параметр "Диалоговое окно подтверждения", который передается через Submit действие.
IDataPoint

Точка данных для визуализации данных.
IDataVisualizationCardViewConfiguration

Конфигурация представления DataVisualization карта.
IDataVisualizationCardViewParameters

Параметры представления DataVisualization карта.
IExecuteActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при Execute выполнении действия. https://adaptivecards.io/explorer/Action.Execute.html
IExecuteCardAction

Action.Execute Вызов события.
IExecuteCardParameters

Параметры для действия Выполнить карта.
IExternalLinkActionArguments

Объект передается в BaseAdaptiveCardExtension.onBeforeAction() при ExternalLink активации действия.
IExternalLinkCardAction

Откройте внешнюю ссылку.
IExternalLinkParameters

Параметры для открытия внешней ссылки.
IFocusParameters

Интерфейс, предоставляющий сторонним разработчикам возможность определять, какой элемент должен получать фокус, когда и как часто следует читать содержимое.
IGetLocationAction

Действие "Получить расположение" в интерфейсе Viva
IGetLocationActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при выполнении действия Get location Action.
IGetLocationActionParameters

Параметры, которые можно предоставить с помощью действия Viva Получить расположение.
IGetLocationCardAction

VivaAction.GetLocation Вызов события.
IImageCardParameters

Параметры данных для BaseImageCardView.
IImageCardViewConfiguration

Конфигурация для представления карточки изображений.
ILineChartCardViewConfiguration

Конфигурация для графика карта представлении.
ILineChartSeries

Ряды для графика.
ILocation

Интерфейс для координат расположения
ILocationActionProvider
ILocationErrorArguments

Этот объект представляет данные об ошибках, которые может вызвать действие Расположение.
INotificationArguments

Объект передается в BaseAdaptiveCardExtension.onNotificationReceived() при получении уведомления.
INotificationResponse

Объект, возвращенный из BaseAdaptiveCardExtension.onNotificationReceived(), если он обработал уведомление.
IPartialMicrosoftTeams

Предоставляет доступ к пакету SDK для Teams и контексту Teams. Предоставляется только при загрузке веб-части в Teams.

В настоящее время мы предоставляем только частичную контекстную информацию.
IPartialSDKs

Условный набор пакетов SDK, предоставляемых SPFx в зависимости от среды.

В настоящее время мы предоставляем только частичные пакеты SDK.
IPartialTeamsContext

Контекст частичных команд
IPartialTeamsJs

Предоставляет доступ к пакету SDK для Teams и контексту Teams. Предоставляется только при загрузке веб-части в Teams.
IPieChartCardViewConfiguration

Конфигурация круговой диаграммы карта представлении.
IPieChartSeries

Ряды для круговой диаграммы.
IPieDataPoint

Точка данных для компонентов визуализации круговых данных.
IPrimaryTextCardParameters

Параметры данных для BasePrimaryTextCardView.
IPrimaryTextCardViewConfiguration

Конфигурация представления основной текстовой карточки.
IQuickViewActionArguments

Объект передается в BaseAdaptiveCardExtension.onBeforeAction() при QuickView активации действия.
IQuickViewCardAction

Откройте быстрое представление.
IQuickViewNavigator

Свойства, описывающие QuickViewNavigator
IQuickViewParameters

Параметры для открытия быстрого представления.
ISearchCardViewConfiguration

Конфигурация для представления карточки поиска.
ISearchCardViewParameters

Параметры для представления карта поиска.
ISelectMediaAction

Интерфейс для нового действия "Выбор мультимедиа Viva"
ISelectMediaActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при SelectMedia выполнении действия.
ISelectMediaActionErrorArguments

Этот объект представляет данные, возвращаемые собственным API средства выбора мультимедиа.
ISelectMediaActionParameters

Параметры, которые можно предоставить с помощью действия Viva Выбрать мультимедиа.
ISelectMediaAttachment

Этот объект представляет данные, возвращаемые собственным API средства выбора мультимедиа.
ISelectMediaCardAction

VivaAction.SelectMedia Вызов события.
IShowCardActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при ShowCard выполнении действия.
IShowLocationAction

Интерфейс для действия "Показать расположение Viva"
IShowLocationActionArguments

Объект передается в BaseAdaptiveCardExtension.onBeforeAction() при ShowLocation активации действия.
IShowLocationActionParameters

Параметры, которые можно предоставить с помощью действия Viva Показать расположение.
IShowLocationCardAction

VivaAction.ShowLocation Вызов события.
ISPFxAdaptiveCard

Схема расширения адаптивных карточек SPFx для адаптивных карточек.
ISubmitActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при Submit выполнении действия.
ISubmitCardAction

Action.Submit Вызов события.
ISubmitCardParameters

Параметры для действия отправки карта.
ITextCardViewParameters

Параметры карта представления с текстом или пустым текстом.
ITextInputCardViewConfiguration

Конфигурация представления карточки ввода текста

*
ITextInputCardViewParameters

Параметры представления карта с текстовым вводом в тексте.
ITextInputImageCardViewConfiguration

Конфигурация представления карточки ввода текста

*
IViewNavigator

Свойства, описывающие ViewNavigator

Псевдонимы типов

BarChartData

Тип служебной программы для определения допустимых типов данных, которые можно использовать при визуализации данных линейчатой диаграммы.
BaseOnBeforeActionArguments

Базовый тип для принудительного применения правильного типа аргументов, передаваемых в BaseAdaptiveCardExtension.onBeforeAction().
CardComponentConfiguration

Конфигурация базового компонента.
CardComponentEventNames

Список всех событий, поддерживаемых компонентами.
CardComponentName

Имена компонентов, разрешенных в представлении карта.
CardDataVisualizationKind

Поддерживаемые визуализации данных для отображения в представлении карта.
CardSearchBoxEventNames

Имена событий, поддерживаемые компонентом поля поиска.
CardSize

Размер представления карточки.
CardTextInputEventNames

Имена событий, поддерживаемые компонентом текстового ввода.
CardViewActionsFooterConfiguration

Конфигурация нижнего колонтитула только для действий для представления карта.
CardViewActionsFooterParameters

Параметры нижнего колонтитула только для действий для представления карта.
ComponentsCardViewParameters

Тип конфигурации представления карточки.
DeviceContext

WebView указывает, что расширение адаптивной карточки отрисовывается через эквивалент веб-браузера. Mobile указывает, что расширение адаптивной карточки изначально отрисовывается на мобильной платформе.
GenericCardViewFooterConfiguration

Конфигурация нижнего колонтитула для шаблонов универсального представления карта.
GenericCardViewFooterParameters

Параметры нижнего колонтитула для шаблонов представления универсальных карта. Может содержать от 0 до 2 кнопок или один текстовый ввод.
IActionArguments

Объект, передаваемый в IAdaptiveCardExtensionActionView.onAction при выполнении действия адаптивной карточки.
IActionErrorArguments

Объект передается в IAdaptiveCardExtensionActionView.onActionError при возникновении ошибки при выполнении действия адаптивной карточки.
IAdaptiveCardExtensionIcon

Значок представления карточки.
ICardAction

Тип обработчика при нажатии кнопки.
IOnBeforeActionArguments

Объект передается в BaseAdaptiveCardExtension.onBeforeAction() при выполнении действия адаптивной карточки.
LineChartData

Тип служебной программы для определения допустимых типов данных, которые можно использовать в визуализации данных на графике.
MaxThreeTuple

Тип служебной программы для принудительного применения кортежа с максимальной длиной 3.
RenderType

Card — это представление отрисовки по умолчанию. QuickView более подробное представление расширения адаптивной карточки.
SupportedBarChartDataTypes

Набор поддерживаемых типов для данных, используемых при визуализации данных линейчатой диаграммы.
SupportedLineChartDataTypes

Набор поддерживаемых типов для данных, используемых при визуализации данных на графике.

Перечисления

MediaType

Значение перечисления для указания типа носителя.

Функции

BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления с числовыми данными.
BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления со строковыми данными.
BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления с данными даты.
BasicCardView(configuration)

Вспомогательный метод для создания базового представления карточки.
ImageCardView(configuration)

Вспомогательный метод для создания представления карточки изображения.
LineChartCardView(configuration)

Вспомогательный метод для создания графика карта представления с числовыми данными.
LineChartCardView(configuration)

Вспомогательный метод для создания графика карта представления с данными даты.
PieChartCardView(configuration)

Вспомогательный метод для создания круговой диаграммы карта представлении
PrimaryTextCardView(configuration)

Вспомогательный метод для создания основного представления текстовой карточки.
SearchCardView(configuration)

Вспомогательный метод для создания представления карточки поиска.
TextInputCardView(configuration)

Вспомогательный метод для создания представления карточки ввода текста.
TextInputImageCardView(configuration)

Вспомогательный метод для создания текстового ввода с помощью представления карточки изображения.

Подробнее о функции

BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления с числовыми данными.

export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<number>): IDataVisualizationCardViewParameters;

Параметры

configuration

IBarChartCardViewConfiguration<number>

Возвращает

IDataVisualizationCardViewParameters

BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления со строковыми данными.

export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<string>): IDataVisualizationCardViewParameters;

Параметры

configuration

IBarChartCardViewConfiguration<string>

Возвращает

IDataVisualizationCardViewParameters

BarChartCardView(configuration)

Вспомогательный метод для создания линейчатой диаграммы карта представления с данными даты.

export declare function BarChartCardView(configuration: IBarChartCardViewConfiguration<Date>): IDataVisualizationCardViewParameters;

Параметры

configuration

IBarChartCardViewConfiguration<Date>

Возвращает

IDataVisualizationCardViewParameters

BasicCardView(configuration)

Вспомогательный метод для создания базового представления карточки.

export declare function BasicCardView(configuration: IBasicTextCardViewConfiguration): ITextCardViewParameters;

Параметры

configuration
IBasicTextCardViewConfiguration

базовая конфигурация представления карта.

Возвращает

ITextCardViewParameters

ImageCardView(configuration)

Вспомогательный метод для создания представления карточки изображения.

export declare function ImageCardView(configuration: IImageCardViewConfiguration): ITextCardViewParameters;

Параметры

configuration
IImageCardViewConfiguration

image карта конфигурации представления.

Возвращает

ITextCardViewParameters

LineChartCardView(configuration)

Вспомогательный метод для создания графика карта представления с числовыми данными.

export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<number>): IDataVisualizationCardViewParameters;

Параметры

configuration

ILineChartCardViewConfiguration<number>

Возвращает

IDataVisualizationCardViewParameters

LineChartCardView(configuration)

Вспомогательный метод для создания графика карта представления с данными даты.

export declare function LineChartCardView(configuration: ILineChartCardViewConfiguration<Date>): IDataVisualizationCardViewParameters;

Параметры

configuration

ILineChartCardViewConfiguration<Date>

Возвращает

IDataVisualizationCardViewParameters

PieChartCardView(configuration)

Вспомогательный метод для создания круговой диаграммы карта представлении

export declare function PieChartCardView(configuration: IPieChartCardViewConfiguration): IDataVisualizationCardViewParameters;

Параметры

configuration
IPieChartCardViewConfiguration

конфигурация представления круговой диаграммы карта.

Возвращает

IDataVisualizationCardViewParameters

круговая диаграмма карта параметры представления.

PrimaryTextCardView(configuration)

Вспомогательный метод для создания основного представления текстовой карточки.

export declare function PrimaryTextCardView(configuration: IPrimaryTextCardViewConfiguration): ITextCardViewParameters;

Параметры

configuration
IPrimaryTextCardViewConfiguration

конфигурация представления основного текстового карта.

Возвращает

ITextCardViewParameters

SearchCardView(configuration)

Вспомогательный метод для создания представления карточки поиска.

export declare function SearchCardView(configuration: ISearchCardViewConfiguration): ISearchCardViewParameters;

Параметры

configuration
ISearchCardViewConfiguration

поиск карта конфигурации представления.

Возвращает

ISearchCardViewParameters

TextInputCardView(configuration)

Вспомогательный метод для создания представления карточки ввода текста.

export declare function TextInputCardView(configuration: ITextInputCardViewConfiguration): ITextInputCardViewParameters;

Параметры

configuration
ITextInputCardViewConfiguration

конфигурация представления карта текстового ввода.

Возвращает

ITextInputCardViewParameters

TextInputImageCardView(configuration)

Вспомогательный метод для создания текстового ввода с помощью представления карточки изображения.

export declare function TextInputImageCardView(configuration: ITextInputImageCardViewConfiguration): ITextInputCardViewParameters;

Параметры

configuration
ITextInputImageCardViewConfiguration

текстовый ввод с конфигурацией представления карта изображения.

Возвращает

ITextInputCardViewParameters