ViewerConfiguration
ViewerConfiguration - Базовый класс, описывающий настройки компонентов PilotWeb2D и PilotWeb3D.
class ViewerConfiguration {
appearance: ViewerSettings = {
[BaseSettingsNames.TOOLBAR] : {
direction: ToolbarDirection.TOP_FLUENT,
content: ToolbarContentAlignment.CENTER
} as ToolbarStyle,
[BaseSettingsNames.THEME] : SettingsTheme.LIGHT_THEME;
};
}
Свойства
appearance
appearance: ViewerSettings;
Параметры внешнего вида вьювера. Подробнее: ViewerSettings.
direction
direction: string;
Управляет положением панели инструментов. Подробнее: ToolbarDirection.
content
content: string;
Управляет расположением кнопок на панели инструментов. Подробнее: ToolbarContentAlignment.
theme
theme: string;
Управляет темой вьювера и его компонентов. Подробнее: SettingsTheme.
settingsPrefix
settingsPrefix: string;
Задает префикс для настроек, хранящихся в браузере клиента.
Методы
mergeConfigurationAndSettings()
Метод объединяет переданную конфигурацию и настройки, заменяя значения из конфигурации значениями из настроек.
public mergeConfigurationAndSettings(configuration: ViewerSettings, settings: ISettings): void;
где:
configuration
– конфигурация. Подробнее: ViewerSettings.
settings
– значение настройки. Подробнее: ISettings.
createConfiguration()
Метод объединяет объединяет свойства из переданных параметров в объект origin. Origin подменяется свойствами из configuration, если configuration не был передан или был передан пустой объект, то configuration присваивается origin по ссылке.
public createConfiguration(configuration: ViewerSettings, origin: ViewerSettings): void;
где:
configuration
– конфигурация. Подробнее: ViewerSettings.
origin
– значение настройки. Подробнее: ViewerSettings.
changeTheme()
Метод меняет тему вьювера.
public changeTheme(newTheme: string): void;
где:
newTheme
– значение новой темы из SettingsTheme. Подробнее: SettingsTheme.
ToolbarDirection
ToolbarDirection - возможные позиции панели инструментов.
export enum ToolbarDirection {
TOP_FIXED = 'ascn-toolbar-fixed-top', // Фиксированный сверху
TOP_FLUENT = 'ascn-toolbar-top', // Не фиксированный сверху
BOTTOM_FIXED = 'ascn-toolbar-fixed-bottom', // Фиксированный снизу
BOTTOM_FLUENT = 'ascn-toolbar-bottom', // Не фиксированный снизу
}
ToolbarContentAlignment
ToolbarContentAlignment - возможные позиции содержимого в панели инструментов.
export enum ToolbarContentAlignment {
CENTER = 'ascn-toolbar-content-center', // По центру
START = 'ascn-toolbar-content-start', // Прижато к левому краю
END = 'ascn-toolbar-content-end' // Прижато к правому краю
}
SettingsTheme
SettingsTheme - возможные варианты темы вьювера.
export enum SettingsTheme {
LIGHT_THEME = 'ascn-light', // Тёмная тема
DARK_THEME = 'ascn-dark', // Светлая тема
}
ViewerSettings
ViewerSettings - настройки, ключами свойств которого являются строки, а значениями свойств является любой тип.
type ViewerSettings = Record<string, any>;