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

IWebPartData interface

  • Ссылка
Пакет:
@microsoft/sp-webpart-base

Эта структура представляет собой сериализованное состояние веб-части.

Комментарии

При вызове serialize() API в веб-части выходными данными должна быть эта структура. Структура поля properties относится к веб-части. Каждая веб-часть может выбрать набор свойств, которые она хочет сериализовать.

Свойства

dataVersion

Версия данных веб-части
description

Описание веб-части
dynamicDataPaths

Пути для динамических данных.
dynamicDataValues

Статические значения для динамических данных. Он используется для восстановления динамических объектов данных при десериализации веб-части.
id

Универсальный уникальный идентификатор типа веб-части.
instanceId

Универсальный уникальный идентификатор экземпляра веб-части. Веб-часть может содержать несколько экземпляров на странице. Ожидается, что этот идентификатор будет универсальным по времени и границам страниц.
properties

Свойства веб-части. Определение этих свойств принадлежит отдельной веб-части.
serverProcessedContent

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

Название веб-части

Сведения о свойстве

dataVersion

Версия данных веб-части

dataVersion: string;

Значение свойства

string

Комментарии

Обратите внимание, что версия данных и поле версии в манифесте — это не одно и то же. Версия манифеста используется для управления версиями кода веб-части, а версия данных — для управления версиями сериализованных данных веб-части. Дополнительные сведения см. в поле dataVersion веб-части.

Поддерживаемые значения: MAJOR. НЕЗНАЧИТЕЛЬНЫЕ

Пример: "1.0"

description

Описание веб-части

description?: string;

Значение свойства

string

Комментарии

Используется для отображения описания веб-части.

Поддерживаемые значения: строка с описанием.

Пример: "Text"

dynamicDataPaths

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Пути для динамических данных.

dynamicDataPaths?: {
        [path: string]: string;
    };

Значение свойства

{ [path: string]: string; }

Комментарии

Он используется для восстановления динамических объектов данных при десериализации веб-части. Ключ — это путь в свойствах веб-части, а значение — внутренний идентификатор динамических данных.

Пример.

{
  'pageContextUser':
    'PageContext:user',
  'anotherWebPartProperty':
    'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty'
}

dynamicDataValues

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Статические значения для динамических данных. Он используется для восстановления динамических объектов данных при десериализации веб-части.

dynamicDataValues?: {
        [path: string]: any;
    };

Значение свойства

{ [path: string]: any; }

Комментарии

Ключ — это путь в свойствах веб-части, а значение — это статическое значение динамических данных.

Пример.

{
  'aStringProperty': 'thisIsAString',
  'aBooleanProperty': true
}

id

Универсальный уникальный идентификатор типа веб-части.

id: string;

Значение свойства

string

Комментарии

Пример: "dbef608d-3ad5-4f8f-b139-d916f2f0a294"

instanceId

Универсальный уникальный идентификатор экземпляра веб-части. Веб-часть может содержать несколько экземпляров на странице. Ожидается, что этот идентификатор будет универсальным по времени и границам страниц.

instanceId: string;

Значение свойства

string

Комментарии

поддерживаемые значения: уникальная строка. Может быть GUID или другими уникально идентифицируемыми форматами.

Примере: ["dbef608d-3ad5-4f8f-b139-d916f2f0a294"]

properties

Свойства веб-части. Определение этих свойств принадлежит отдельной веб-части.

properties?: any;

Значение свойства

any

Комментарии

Используется веб-частью для управления внутренними метаданными и данными конфигурации. Код платформы никогда не касается этих свойств.

Поддерживаемые значения: любая иерархия объектов, которую можно сериализовать с помощью JSON.stringify().

Пример: { 'value': 'text value' }

serverProcessedContent

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

serverProcessedContent?: ISerializedServerProcessedData;

Значение свойства

ISerializedServerProcessedData

title

Название веб-части

title: string;

Значение свойства

string

Комментарии

Используется для отображения имени веб-части на панели элементов, в коллекции веб-частей и на странице.

Поддерживаемые значения: строка менее 100 символов

Пример: "Text"