import * as i0 from '@angular/core'; import { NgZone, AfterViewInit, ElementRef, AfterViewChecked, OnDestroy, QueryList, EventEmitter, OnInit, ChangeDetectorRef, ComponentRef, ApplicationRef, ComponentFactoryResolver, Injector, ViewContainerRef, Type, PipeTransform, OnChanges, SimpleChanges, AfterContentInit } from '@angular/core'; import { ControlValueAccessor, NgControl } from '@angular/forms'; import { Observable, Subscription } from 'rxjs'; import { Router } from '@angular/router'; declare class SohoAboutModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Wrapper for the jQuery about control. */ declare class SohoAboutRef { private ngZone; private eventGuard; /** Selector referencing the about-dialog after it has been moved to the dialog container. */ private jQueryElement?; /** Soho Control Api */ private _about?; /** Dialog placeholder, defaults to $('body')*/ private _placeholder; /** * Cached options. */ private _options; /** * Sets the whole options block for this modal dialog. * * @param options - the options to set. */ options(options?: SohoAboutOptions): SohoAboutRef; /** * Sets the appName on the about dialog * * @param appName - the application name */ appName(appName: string): SohoAboutRef; /** * Sets the additional 'content' that the about dialog displays. * * @param content - the additional text content */ content(content: string): SohoAboutRef; /** * Sets the copyrightYear of the about dialog. */ copyrightYear(copyrightYear: string): SohoAboutRef; /** * Sets Whether or not to show the deviceSpecs * * @param deviceSpecs - if true; the about dialog will show device info */ deviceSpecs(deviceSpecs: boolean): SohoAboutRef; /** * Sets The Additional productName * * @param productName - the product name */ productName(productName: string): SohoAboutRef; /** * Sets The Additional productName * * @param productName - the product name */ useDefaultCopyright(useDefaultCopyright: boolean): SohoAboutRef; /** * Sets about dialog version * * @param version - the semantic version no fx 4.0.1 */ version(version: string): SohoAboutRef; /** * Add extra attributes like id's to the component * * @param attributes - the array or object of attributes to add */ attributes(attributes: Array | Object): SohoAboutRef; /** * Constructor. * * @param placeholder for the about dialog; defaults to the body. */ constructor(ngZone: NgZone); /** * Displays the about dialog. * * @return the dialog ref. */ open(): SohoAboutRef; /** * Closes the about dialog, if open. * * @param dialogResult - optional result - held for the caller. */ close(): SohoAboutRef; /** * Registers a before open guard. * * @param eventFn - the function to call before openning the dialog. */ beforeOpen(eventFn: (dialogRef?: SohoAboutRef) => boolean): SohoAboutRef; /** * Registers a closed guard. * * @param eventFn - the function to call before openning the dialog. */ closed(eventFn: (dialogRef?: SohoAboutRef) => boolean): SohoAboutRef; /** * Registers a after close guard. * * @param eventFn - the function to call before openning the dialog. */ afterClose(eventFn: (dialogRef?: SohoAboutRef) => boolean): SohoAboutRef; /** * Handles the 'beforeOpen' event, fired before the modal dialog * has been opened. * * @param event - full event object. * * @return true if the dialog can be opened; otherwise false if veoted. */ private onBeforeOpen; /** * Handles the 'closed' event, fired before the modal dialog * has been opened. * * @param event - full event object. * * @return true if the dialog can be opened; otherwise false if veoted. */ private onClose; /** * Handles the 'afterClose' event, fired before the modal dialog * has been opened. * * @param event - full event object. * * @return true if the dialog can be opened; otherwise false if veoted. */ private onAfterClose; } /** * Event Handlers. */ interface SohoAboutDialogEventGuard { /** * Invoked before a modal is opened. * * @return false to veto the open action; otherwise true. */ beforeOpen?(dialogRef: SohoAboutRef): boolean; /** * Invoked when closing a modal. * * @return false to veto the open action; otherwise true. */ closed?(dialogRef: SohoAboutRef): boolean; /** * Invoked after the modal is closed. * * @return false to veto the open action; otherwise true. */ afterClose?(dialogRef: SohoAboutRef): boolean; } /** * This service is used to create about dialogs. */ declare class SohoAboutService { private readonly ngZone; /** * Constructor. */ constructor(ngZone: NgZone); /** * Creates a about defined by the given info, returning a reference to the * associated about dialog that can be interacted with. * * The about dialog won't be open until open is called on the returned instance, * see the about ref api for further methods. * * @parent options - a compete set of options; can be null. * * @return the about reference. */ about(options?: SohoAboutOptions): SohoAboutRef; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SohoAccordionHeaderComponent implements AfterViewInit { elementRef: ElementRef; /** * Reference to the jQuery control - this is public so * it can be used in the api on the accordion control. */ jQueryElement: JQuery; isDisabled: boolean; isBlockDisplay: string; isAccordionHeader: boolean; isExpanded: boolean; moduleNavItem: boolean; /** * Constructor. * * @param elementRef - the element matching the component's selector. */ constructor(elementRef: ElementRef); ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoAccordionPaneComponent { get isAccordionPane(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Angular Wrapper for the Soho Accordion control. * * This component searches for an element, annotated with the `soho-accordion` attribute, * and then matches this component to it. *
* The characteristics of the component can be controlled using the set of inputs. * * The Accordion is a grouped set of collapsible panels used to navigate sections of * related content. Each panel consists of two levels: the top level identifies the * category or section header, and the second level provides the associated options. */ declare class SohoAccordionComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; headers: QueryList; panes: QueryList; options: SohoAccordionOptions; /** Reference to the jQuery selector. */ private jQueryElement; /** * References to the Soho control api. */ private accordion; /** * Used to call updated from the afterViewChecked lifecycle event. */ private updateRequired?; beforeexpandEvent: EventEmitter; beforecollapseEvent: EventEmitter; beforeselectEvent: EventEmitter; selectedEvent: EventEmitter; followlinkEvent: EventEmitter; expandEvent: EventEmitter; afterexpandEvent: EventEmitter; collapseEvent: EventEmitter; aftercollapseEvent: EventEmitter; /** * If an Accordion pane is open, and that pane contains sub-headers, only one * of the pane's sub-headers can be open at a time. * * Defaults to true. * * If set to true, allows only one pane of the accordion to be open at a time. */ set allowOnePane(allowOnePane: boolean | undefined); get allowOnePane(): boolean | undefined; /** * Displays a "Chevron" icon that sits off to the right-most side of a top-level accordion header. * Used in place of an Expander (+/-) if enabled. * * */ set displayChevron(displayChevron: boolean | undefined); get displayChevron(): boolean | undefined; /** * Changes the iconography used in accordion header expander buttons. */ set expanderDisplay(expanderDisplay: SohoAccordionExpanderType | undefined); get expanderDisplay(): SohoAccordionExpanderType | undefined; /** * Can be set to false if routing is externally handled, otherwise * links are handled normally. */ set rerouteOnLinkClick(rerouteOnLinkClick: boolean | undefined); get rerouteOnLinkClick(): boolean | undefined; /** * Add a alert badge to the accordion header (used for App menu) */ set notificationBadge(notificationBadge: boolean | undefined); get notificationBadge(): boolean | undefined; /** * A callback function that when implemented provided a call back for "ajax loading" of tab contents on open. */ set source(source: Function | undefined); get source(): Function | undefined; /** * Display accordion with panels */ set hasPanels(hasPanels: boolean | undefined); get hasPanels(): boolean | undefined; /** * Set the color scheme to inverse */ set inverse(inverse: boolean | undefined); get inverse(): boolean | undefined; /** * Set the color scheme to alternate */ set alternate(bool: boolean | undefined); get alternate(): boolean | undefined; /** * Enables tooltips for longer text that is handled with ellipsis */ set enableTooltips(enableTooltips: boolean | undefined); get enableTooltips(): boolean | undefined; hasSubheaderSeparators?: boolean; /** Enables Module Nav variant */ moduleNav?: boolean; /** * Constructor. * * @param elementRef - the element matching the component's selector. * @param ngZone - zone access. */ constructor(element: ElementRef, ngZone: NgZone); /** * Makes provided accordion headers appear "selected" */ select(header: SohoAccordionHeaderComponent | string): void; /** * Makes provided accordion headers appear "deselected" */ deselect(header: SohoAccordionHeaderComponent | string): void; /** * Makes all accordion headers appear "deselected" */ deselectAll(): void; /** * Get's the nth header from the accordion. * * @todo - how best to access the headers? * * @param index - the index of the accordion header. * @return the header at the given index. */ getHeader(index: number): SohoAccordionHeaderComponent | undefined; /** * Expand the given Panel on the Accordion. * * @param header  -  the header component */ expand(header: SohoAccordionHeaderComponent | string): void; /** * Collapse the given Panel on the Accordion. * * @param header  -  the jquery header element */ collapse(header: SohoAccordionHeaderComponent | string): void; /** * Expands all accordion headers, if possible. */ expandAll(): void; /** * Collapses all the expanded panels. * * */ collapseAll(): void; /** * Disables the control. */ disable(): void; /** * Enables the control. */ enable(): void; /** * Returns true if the given header is currently disabled or the whole accordion * is disabled; otherwise false. * * @param header the accordion header panel to check. */ isDisabled(header: SohoAccordionHeaderComponent): boolean; /** * Returns true if the given header is currently expanded; otherwise * false. * * @param header the accordion header panel to check. */ isExpanded(header: SohoAccordionHeaderComponent): boolean; /** * Toggle the given Panel on the Accordion between expanded and collapsed * * @param header  -  the jquery header element */ toggle(header: SohoAccordionHeaderComponent): void; /** * Call to notify the accordion about any dom changes */ updated(headers?: JQuery[], settings?: SohoAccordionOptions): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Destructor. */ ngOnDestroy(): void; private markForUpdate; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoAccordionModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoActionsheetComponent implements AfterViewInit, OnDestroy { private element; private ngZone; display: string; /** * Constructor * * @param elementRef - the element matching the component's selector. * @param ngZone - the angular zone for this component. */ constructor(element: ElementRef, ngZone: NgZone); private _options; private actionsheet?; private jQueryElement; set actions(actions: Array | undefined); get actions(): Array | undefined; set showCancelButton(showCancelButton: boolean | undefined); get showCancelButton(): boolean | undefined; set autoFocus(autoFocus: boolean | undefined); get autoFocus(): boolean | undefined; set breakpoint(breakpoint: string | undefined); get breakpoint(): string | undefined; set displayAsActionSheet(displayAsActionSheet: SohoActionsheetDisplay | undefined); get displayAsActionSheet(): SohoActionsheetDisplay | undefined; set overlayOpacity(overlayOpacity: number | undefined); get overlayOpacity(): number | undefined; set onSelect(onSelect: Function | undefined); get onSelect(): Function | undefined; set onCancel(onCancel: Function | undefined); get onCancel(): Function | undefined; set tray(tray: boolean | undefined); get tray(): boolean | undefined; set trayOpts(trayOpts: SohoActionsheetTrayOptions | undefined); get trayOpts(): SohoActionsheetTrayOptions | undefined; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; ngAfterViewInit(): void; /** Tears down and removes any added markup and events. */ ngOnDestroy(): void; /** * Triggers a UI Resync. */ updated(settings?: SohoActionsheetOptions): void; /** * Tears down and removes any added markup and events. */ destroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoActionsheetModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the SohoAlert Directive. * */ declare class SohoAlertDirective implements AfterViewInit { elementRef: ElementRef; private ngZone; private _options; private jQueryElement?; /** Set or remove the message. */ set message(message: string); set id(id: string | undefined); set type(type: SohoAlertType); /** Set message with or without control color */ set isAlert(isAlert: boolean | undefined); set truncated(truncated: boolean); /** Set message whether to trigger events */ set triggerEvents(triggerEvents: boolean | undefined); /** Set message with or without custom icon */ set icon(icon: string | undefined); /** * Returns the data object data-errormessage * * @deprecated use getMessage() instead * @return error */ get errorMessage(): string; constructor(elementRef: ElementRef, ngZone: NgZone); /** * After the control has been initialised and the view is ready, * get the SoHoXi controls to activate any alerts. */ ngAfterViewInit(): void; /** * Adds an inline error message * * @deprecated use addInlineMessage() instead * @param message the error message to add. */ addInlineError(message: string): void; /** * Adds an inline message of the type specified * * @param message the message to add. * @param type optional - 'error' (default) * @param isAlert optional - false (default) * @param triggerEvents optional - true (default) * @param icon optional - icon for the message * @param id optional - id for the message */ addInlineMessage(message: string, type?: SohoAlertType, isAlert?: boolean, triggerEvents?: boolean, icon?: string, id?: string): void; /** * Gets the message of the type specified * * @param type optional - 'error' default * @return returns the message for the given type. */ getMessage(type?: SohoAlertType): string; /** * Removes the error message * * @deprecated use removeMessage() instead */ removeError(): void; /** * Removes the message of the type specified * * @param type optional - 'error' (default) * @param triggerEvents optional - true (default) triggers events */ removeMessage(type?: SohoAlertType, triggerEvents?: boolean | undefined): void; /** * Removes the message for all types * * @param triggerEvents optional - true (default) triggers events */ removeAllMessages(triggerEvents?: boolean): void; /** * Scrolls the element into the visible area of the browser window * * @param alignToTop optional - true (default) element will be aligned to the top of the visible area of the scrollable ancestor */ scrollIntoView(alignToTop?: boolean): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoAlertModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the Soho Application Menu Component. * * This component searches for a nav element with the attribute * 'soho-applcation-menu' in the parent's DOM tree, initialising those found with * the Soho application menu control. */ declare class SohoApplicationMenuComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; /** Breakpoint. */ breakpoint?: SohoApplicationMenuBreakPoint; /** Sets Open on resize */ set openOnLarge(openOnLarge: boolean | undefined); get openOnLarge(): boolean | undefined; /** Allows the menu to become closed after an actionable header has been selected */ set dismissOnClickMobile(dismissOnClickMobile: boolean | undefined); get dismissOnClickMobile(): boolean | undefined; /** A list of jQuery elements which trigger the openning and closing application menu. */ set triggers(triggers: string[]); /** * Is the application menu filterable? */ filterable?: boolean; /** * Is the application menu resizable? */ set resizable(resizable: boolean | undefined); get resizable(): boolean | undefined; /** * Resizeable Save Position Settings */ set savePosition(savePosition: boolean | undefined); get savePosition(): boolean | undefined; /** * * @param expandSwitcher * Menu switcher expand setting to provide callback */ set onExpandSwitcher(expandSwitcher: SohoApplicationMenuExpandSwitcherFunction); /** * * @param collapseSwitcher * Menu switcher collapse setting to provide callback */ set onCollapseSwitcher(collapseSwitcher: SohoApplicationMenuCollapseSwitcherFunction); appMenu: boolean; isPersonalizable: boolean; /** * This will let the Soho controls bind the application menu trigger naturally */ get menuId(): string; /** Reference to the jQuery element. */ private jQueryElement?; /** Reference to the annotated SoHoXi control */ private applicationmenu?; /** List of jQuery triggers. */ private _triggers; /** Open on resize */ private _openOnLarge?; /** Dismiss the menu when an item is clicked in the mobile breakpoints */ private _dismissOnClickMobile?; private _resizable?; private _savePosition?; /** Menu switcher expand callback */ private _onExpandSwitcher?; /** Menu switcher collapse callback */ private _onCollapseSwitcher?; /** * This event is fired when the visibility of the application menu is changed, * is it also called when the item is changed programmatically. * * @deprecated use accordionExpand and accordionCollapse events instead */ visibility: EventEmitter; /** * This event is fired when a menu accordion is expamded * The event include the anchor element. */ accordionExpand: EventEmitter; /** * This event is fired when a menu accordion is collapsed */ accordionCollapse: EventEmitter; /** This event is fired when the visibility of the application menu is changed */ menuVisibility: EventEmitter; /** This event is fired when the application menu is filtered. */ filtered: EventEmitter; /** flag the need to update the soho/ep control in ngAfterViewChecked. */ private updateRequired; constructor(elementRef: ElementRef, ngZone: NgZone); /** * Close the menu. */ closeMenu(): void; /** Open the menu. */ openMenu(noFocus?: boolean, userOpened?: boolean, openedByClass?: boolean): void; /** * Returns true if the menu is open, otherwise false. */ isOpen(): boolean | undefined; /** * Notifies application menu that it has been updated */ updated(): void; /** * Closes the panel area controlled by switcher */ closeSwitcherPanel(): void; updateLazy(applicationMenu: SohoApplicationMenuComponent, target: any): void; toggleAndSelectHeader(applicationMenu: SohoApplicationMenuComponent, header: any): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Destructor. */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoApplicationMenuModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoArrangeDirective implements AfterViewInit, OnDestroy { private elementRef; private ngZone; private jQueryElement?; private _arrangeOptions; private arrange?; beforeArrange: EventEmitter; arrangeUpdate: EventEmitter; dragEnd: EventEmitter; set arrangeOptions(arrangeOptions: SohoArrangeOptions); constructor(elementRef: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngOnDestroy(): void; updated(settings?: SohoArrangeOptions): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoArrangeModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare const NOOP: any; /** * Base class for new components that need to support NgForms. */ declare class BaseControlValueAccessor implements ControlValueAccessor { /** Current value. */ private _value?; /** ControlValueAccessor method called when the attached control has changed, */ protected _onChangeCallback: (_: T) => void; /** ControlValueAccessor method called when the attached control has touched. */ private _onTouchedCallback; /** Gets the value for the control. */ protected get internalValue(): T | undefined; /** Sets the value for the control. */ protected set internalValue(newValue: T | undefined); /** * When touched. */ protected touched(): void; /** * ------------------------------------------------- * ControlValueAccessor implementation * ------------------------------------------------- */ /** * Write a new value to the element. */ writeValue(value: T): void; /** * Set the function to be called when the control receives a change event. */ registerOnChange(fn: (_: T) => void): void; /** * Set the function to be called when the control receives a touched event. */ registerOnTouched(fn: () => void): void; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(_isDisabled: boolean): void; } /** * Provider - adds the contol value accessor. */ declare function provideControlValueAccessor(type: any): any; declare class SohoAutoCompleteComponent extends BaseControlValueAccessor implements AfterViewInit, AfterViewChecked, OnDestroy { private element; /** Options. */ private options; /** Defines the data to use, must be specified for this component. */ set source(source: SohoAutoCompleteSource); /** Object is passed into the source method, and augmented with parameters. */ set sourceArguments(sourceArguments: string); /** Menu template, appropriate markup is expected. */ set template(template: string); /** if true, causes filter results that don't match case to be thrown out. */ set caseSensitive(caseSensitive: boolean); /** Filters based on the first character('startsWidth') of the string, or the entire string('contains') */ set filterMode(filterMode: SohoAutoCompleteFilterMode); /** Delay between key strokes on the keypad before the end of typing */ set delay(delay: number); /** Width of the open menu */ set width(width: SohoAutoCompleteWidth); /** Offset, the left or top offset */ set offset(offset: SohoAutoCompleteOffset); /** Selects first item menu */ set autoSelectFirstItem(autoSelectFirstItem: boolean); set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** * Available Soho Template events as Output (EventEmitters passing the event) * Should match the Soho event names for the component * * @todo replace override of native attribute. */ change: EventEmitter; selected: EventEmitter; beforeopen: EventEmitter; get isAutoComplete(): boolean; /** * Local variables */ private isDisabled?; private isReadOnly?; private jQueryElement; private autocomplete; set disabled(value: boolean | undefined); get disabled(): boolean | undefined; set readonly(value: boolean | undefined); get readonly(): boolean | undefined; constructor(element: ElementRef); onKeyUp(_event: KeyboardEvent): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; /** * Handle the control being changed. */ onChange(event: any[]): void; /** * Override writeValue to allow the mask input * element to be updated correctly. * * @param value - the new value */ writeValue(value: any): void; getValue(): string | undefined; setValue(value: string): void; /** For async methods, reinit autocomplete `source` setting. */ updated(): SohoAutoCompleteComponent; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(isDisabled: boolean): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoAutoCompleteModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoBarComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private options; get isBar(): boolean; /** Defines the data to use, must be specified for this component. */ set dataset(dataset: Array); /** Chart Type */ set type(value: SohoBarType); /** Default is a single or stacked chart. */ set isStacked(value: boolean); /** If true its a 100% bar chart. */ set isNormalized(value: boolean); /** If true its a grouped bar chart. */ set isGrouped(value: boolean); /** If false the legend will not be shown. */ set showLegend(value: boolean); /** true|false - will do or not do the animation, 'initial' will do only first time the animation. */ set animate(value: boolean); /** If true, the component will not resize when resizing the page. */ set redrawOnResize(value: boolean); /** Use d3 format some examples can be found on http://bit.ly/1IKVhHh */ set formatterString(value: string); /** The d3 axis format. */ set format(value: string); /** A tooltip for the whole chart. */ set tooltip(value: string); /** If true log scale is enabled. */ set useLogScale(value: boolean); /** Settings for the chart ticks. Can set ticks: {format: d3Format, number: n} */ set ticks(value: object); /** Show the in the axis lines or not. */ set showLines(value: boolean); /** How far out than the outer circle should the labels be placed, this * may be useful to adjust for some labels. */ set labelFactor(value: number); /** The number of pixels after which a label needs to be given a new line. * You may want to change this based on label data. */ set wrapWidth(value: number); /** If true chart height will fit in parent available height. */ set fitHeight(value: boolean); /** An empty message will be displayed when there is no chart data. */ set emptyMessage(value: SohoEmptyMessageOptions); /** * Add extra attributes like id's to the component * * @param attributes - the array or object of attributes to add */ set attributes(attributes: Array | Object); /** Events */ selected: EventEmitter; unselected: EventEmitter; rendered: EventEmitter; dblclick: EventEmitter; /** * @todo replace override of native attribute */ contextmenu: EventEmitter; private jQueryElement?; private bar?; private updateRequired; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; ngAfterViewChecked(): void; updated(): void; /** Tear Down */ ngOnDestroy(): void; setSelected(selected: SohoBarSelected): void; toggleSelected(selected: SohoBarSelected): void; getSelected(): SohoBarSelected; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoBarModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoBlockGridComponent implements AfterViewInit, OnDestroy { private element; private ngZone; /** Options. */ private options; private jQueryElement?; private blockgrid?; get isBlockGrid(): boolean; /** Defines the data to use, must be specified for this component. */ set dataset(dataset: Array | undefined); get dataset(): Array | undefined; /** Defines the selection type. */ set selectable(selectable: SohoBlockGridSelectable); get selectable(): SohoBlockGridSelectable; /** Defines whether or not paging is active. */ set paging(paging: boolean | undefined); get paging(): boolean | undefined; /** Defines the current page size */ set pagesize(pagesize: number | undefined); get pagesize(): number | undefined; /** Defines the array of selectable page sizes */ set pagesizes(pagesizes: Array | undefined); get pagesizes(): Array | undefined; /** Add extra attributes like id's to the component **/ set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; selected: EventEmitter; deselected: EventEmitter; activated: EventEmitter; deactivated: EventEmitter; page: EventEmitter; pagesizechange: EventEmitter; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; /** Tear Down */ ngOnDestroy(): void; /** Reinit blockgrid settings */ updated(settings: any): SohoBlockGridComponent; activateBlock(idx: number): void; deactivateBlock(): void; selectBlocks(idx: number[]): void; private onSelected; private onDeselected; private onActivated; private onDeactivated; private onPage; private onPageSizeChange; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoBlockGridModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Soho Breadcrumb Component */ declare class SohoBreadcrumbComponent implements AfterViewInit, OnDestroy, OnInit { private element; private ngZone; private jQueryElement?; private breadcrumbAPI?; private options; get isBreadcrumb(): boolean; /** Allow Breadcrumb Definition by Input */ set breadcrumbs(items: SohoBreadcrumbItemOptions[] | undefined); get breadcrumbs(): SohoBreadcrumbItemOptions[] | undefined; /** Allow change to alternate styling via Input **/ set alternate(val: boolean); get alternate(): boolean; /** Add truncatling behavior when a lot of items */ set truncate(truncate: boolean | undefined); get truncate(): boolean | undefined; /** Add extra attributes like id's to the component **/ set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** Provides access to the internal array of currently-invoked IDS Breadcrumb APIs */ get breadcrumbAPIs(): SohoBreadcrumbItemStatic[]; /** Provides access to the IDS Breadcrumb's disabled property */ get disabled(): boolean | undefined; /** * Constructor * * @param elementRef - the element matching the component's selector. */ constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngOnDestroy(): void; ngOnInit(): void; enable(): void; disable(): void; /** * Adds a new breadcrumb item to the list */ add(settings?: SohoBreadcrumbItemOptions, doRender?: boolean): void; /** * Removes a single breadcrumb item from the list */ remove(item: SohoBreadcrumbRef, doRender?: boolean): void; /** * Removes all breadcrumb items from the list */ removeAll(doRender?: boolean): void; /** * Gets references related to a particular Breadcrumb Item. * The return object contains: * - 'a' : a reference to the breadcrumb item's anchor tag * - 'api' : a reference to the breadcrumb item's API * - 'i' : a number representing the current index of the breadcrumb item. */ getBreadcrumbItem(item: SohoBreadcrumbRef): SohoBreadcrumbTargetObject | undefined; /** * Takes a reference to a Breadcrumb item and makes it "Current", * styling it with bold text and popping it out of truncation. */ makeCurrent(item: SohoBreadcrumbRef): void; /** * Updates the Breadcrumb List with new incoming settings */ updated(settings?: SohoBreadcrumbOptions): void; /** * Destroys this component and tears down the IDS Breadcrumb */ destroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoBreadcrumbListComponent { isBreadcrumbList: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoBreadcrumbModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoBulletComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private options; get isBullet(): boolean; /** Defines the data to use, must be specified for this component. */ set dataset(dataset: SohoDatasetOptions); /** true|false - will do or not do the animation and 'initial' will do only first time the animation. */ set animate(value: any); /** If true, the component will not resize when resizing the page. There is tooltip values provided. * It will not be shown. If you still want lines at the lower breakpoint you can set this to true */ set redrawOnResize(value: boolean); selected: EventEmitter; rendered: EventEmitter; dblclick: EventEmitter; /** * @todo replace override of native attribute */ contextmenu: EventEmitter; private jQueryElement?; private bullet?; private updateRequired; constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngAfterViewChecked(): void; updated(): void; /** Tear Down */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoBulletModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the SoHo Busy Indicator control. * * This component searches for an element, annotated with the soho-busyindicator attribute, * and then matches this component to it. *
* The characteristics of the component can be controlled using the set of inputs. *
* When activated, this control will display the busy indicator over the control appropriately. */ declare class SohoBusyIndicatorDirective implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; private options; private jQueryElement?; private initiallyActive?; private busyindicator?; private updateBusyIndicator; afterstart: EventEmitter; /** * This event is fired when 'timeToComplete' milliseconds is reached * after the indicator is opened. * * @todo replace override of native attribute */ complete: EventEmitter; set blockUI(blockUI: boolean); set displayDelay(displayDelay: number); set timeToComplete(timeToComplete: number); /** Custom Text To Show or Will Show Localized 'Loading...' */ set text(text: string); /** Controls the activated state of the busy indicator. */ set activated(value: boolean | undefined); /** * Display an overlay that prevents interaction, * but appears transparent instead of gray. */ set transparentOverlay(transparentOverlay: boolean); /** * To display only the overlay w/o the badge and text. Useful to stop input to a component * that doesn't already have another mechanism (like a disabled state). */ set overlayOnly(overlayOnly: boolean); /** * To display only the overlay w/o the badge and text. Useful to stop input to a component * that doesn't already have another mechanism (like a disabled state). */ set attributes(attributes: Array | Object); /** * To get the attributes of the busy indicator. Useful for things like getting an indicator based on an Id. */ get attributes(): Object | Array; /** * Constructor. * * @param elementRef - the element matching the component's selector. */ constructor(elementRef: ElementRef, ngZone: NgZone); /** * Closes the indicator, if open. */ close(fromEvent: boolean): void; /** * Displays the busy indicator. */ open(): void; isActive(): boolean | undefined; ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Destructor. */ ngOnDestroy(): void; /** * Publishes the event, after annotating the event. */ private onAfterStart; /** * Publishes the event, after annotating the event. */ private onComplete; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } /** * Customised event object. */ interface SohoBusyIndicatorEvent { /** Event Type. */ type: 'afterstart' | 'complete'; /** Source Component. */ component: SohoBusyIndicatorDirective; /** Full JQuery Event. */ event: JQuery.TriggeredEvent; } declare class SohoBusyIndicatorModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Supported button types. */ type SohoButtonType = 'btn' | 'primary' | 'secondary' | 'tertiary' | 'icon' | 'favorite' | 'modal' | 'modal-primary' | 'primary-destructive' | 'tertiary-destructive' | 'primary-generative' | 'tertiary-generative' | 'icon-generative'; declare class SohoButtonComponent implements AfterViewInit, OnDestroy, OnInit { private element; private ngZone; static BTN: SohoButtonType; static PRIMARY: SohoButtonType; static SECONDARY: SohoButtonType; static TERTIARY: SohoButtonType; static ICON: SohoButtonType; static FAVORITE: SohoButtonType; static MODAL: SohoButtonType; static MODAL_PRIMARY: SohoButtonType; static PRIMARY_DESTRUCTIVE: SohoButtonType; static TERTIARY_DESTRUCTIVE: SohoButtonType; static PRIMARY_GENERATIVE: SohoButtonType; static TERTIARY_GENERATIVE: SohoButtonType; static ICON_GENERATIVE: SohoButtonType; /** Reference to the jQuery control. */ private jQueryElement?; /** Reference to the Soho control api. */ private button?; /** The type of the button. */ private buttonType?; private _buttonOptions; private _isToggle; private _isTogglePressed; private _iconAlign; private _isPressed; /** * The type of the button, defaulting to 'secondary'. * * Allow override of input, to match component selector. */ set sohoButton(type: SohoButtonType | "" | undefined); /** * Sets the button options */ set buttonOptions(buttonOptions: SohoButtonOptions); get buttonOptions(): SohoButtonOptions; set toggleOnIcon(toggleOnIcon: string); set toggleOffIcon(toggleOffIcon: string); set replaceText(replaceText: boolean); set hideMenuArrow(value: boolean | undefined); get hideMenuArrow(): boolean | undefined; /** * Used to add a bigger hit area (for mobile) */ set hitbox(value: boolean | undefined); get hitbox(): boolean | undefined; /** * Used to set a notification badge on the button */ set notificationBadge(value: boolean | undefined); get notificationBadge(): boolean | undefined; /** * Set the position and color of the notification badge on the button */ set notificationBadgeOptions(value: SohoNotificationBadgeOptions | undefined); get notificationBadgeOptions(): SohoNotificationBadgeOptions | undefined; /** * Used to set an extra class on the soho-icon being used by soho-button. * Useful to set emerald06-color azure10-color to change the icon color. */ extraIconClass?: string; /** * Whether this button should be a toggle button or not. Alternate toggle on/off icons * can be used through toggleOnIcon/toggleOffIcon inputs. */ set isToggle(isToggle: boolean); get isToggle(): boolean; /** * Whether the toggle button should be in a pressed state or not. */ set isTogglePressed(isTogglePressed: boolean); get isTogglePressed(): boolean; /** * The icon to be used * - shows when the state is true if toggle has a value */ icon?: string; /** * The icon placement */ set iconAlign(iconAlign: string); get iconAlign(): string; /** Sets the button type to 'submit' when true. */ isSubmit: boolean; /** Sets whether the button should have a ripple effect on click. */ ripple: boolean; /** * Binary state (toggle): * 0 - shows toggle * 1 - shows icon (default) * * @deprecated use isToggle=true input instead along with toggleOnIcon/toggleOffIcon options */ state?: boolean; /** * The icon to be used when the state is false. * * @deprecated use isToggle=true input instead along with toggleOnIcon/toggleOffIcon options */ toggle?: string; /** * Sets the expandable-expander class to be placed on the button for the * soho-expandablearea to use as it's expand/collapse trigger * */ expandableExpander: boolean; get btn(): boolean; get btnPrimary(): boolean; get btnSecondary(): boolean; get btnTertiary(): boolean; get btnIcon(): boolean; get btnToggle(): boolean; get btnModal(): boolean; get btnModalPrimary(): boolean; get btnDestructive(): boolean; get btnGenerative(): boolean; get btnTogglePressed(): boolean; get iconFavorite(): boolean; moveToLeft: any; moveToRight: any; moveToSelected: any; get noRipple(): boolean; get type(): "submit" | "button"; get isExpandableExpander(): boolean; /** * @deprecated no longer needed once this.toggle is removed. */ toggleState(): void; get ariaPressed(): boolean; /** * Constructor. * * @param elementRef - the element matching the component's selector. */ constructor(element: ElementRef, ngZone: NgZone); ngOnInit(): void; ngAfterViewInit(): void; /** * Destructor. */ ngOnDestroy(): void; get hasIcon(): boolean | "" | undefined; get hasIconEnd(): boolean | "" | undefined; get currentIcon(): string | undefined; /** * @deprecated use isToggle and isTogglePressed instead. */ isPressed(): boolean; performAnimation(delay?: Number): void; startAnimation(): void; stopAnimation(): void; updated(settings?: SohoButtonOptions): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconUseComponent { get href(): string; icon?: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconComponent { private elementRef; isIcon: boolean; get ariaHidden(): boolean | null; focusable: boolean; role: string; isEmptyState: boolean; /** * Extra class that will be placed on the soho-icon element. * Useful to set emerald06-color azure10-color to change the icon color. */ set extraIconClass(extraIconClass: string | undefined); set alert(alert: boolean | undefined); get alert(): boolean | undefined; set icon(icon: string | undefined); get icon(): string | undefined; private _alert?; private _icon?; private _extraIconClass?; constructor(elementRef: ElementRef); private setAlertIcon; private setExtraIconsClass; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsEmptyComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsEmptyClassicComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * @deprecated All icons are now in one file per theme (theme-classic-svg.html or theme-new-svg.html), * and hence this component is deprecated and will be removed in the next major release. */ declare class SohoIconsExtendedComponent { none: string; constructor(); static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsUpliftComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsEmptyUpliftComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsNewComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * @deprecated As of 15.0 the "new" or "colorful" icons can be used with `SohoIconsEmptyComponent` (``) instead. */ declare class SohoIconsEmptyNewComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconsAppComponent { none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoIconModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoButtonModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoButtonsetComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ref; private ngZone; /** Reference to the jQuery control. */ private jQueryElement?; /** Reference to the Soho buttonset api. */ private buttonset?; /** Settings (options) */ private settings; /** Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; /** * Constructor. * * @param element - the element matching the component's selector. * @param ref - change detector reference for the component. * @param ngZone - angular zone. */ constructor(element: ElementRef, ref: ChangeDetectorRef, ngZone: NgZone); /** * The list of buttons definitions. * * @params buttons - list of modal button definitions to use. */ set buttons(buttons: SohoButtonOptions[] | undefined); get buttons(): SohoButtonOptions[] | undefined; /** * Detect existing buttons in the markup rather than generating * new button markup. */ set detectHTMLButtons(value: boolean | undefined); get detectHTMLButtons(): boolean | undefined; /** * Styles to add to any generated button markup. */ set style(style: string | undefined); get style(): string | undefined; get buttonAPIs(): SohoButtonStatic[]; /** * Disable all the buttons on the buttonset. * * @param val whether or not the Buttonset is disabled. */ set disabled(val: boolean); /** * Adds a new button to the Buttonset. * * @param button button definition. * @param [doAddDOM=false] if true, appends the new element to the Buttonset container after creation/update. */ add(button: SohoButtonOptions, doAddDOM?: boolean): void; /** * Removes a button from the buttonset, based on the API, HTML Element or element id. * * @param buttonAPI a button, an html element, or button id. * @param [doRemoveDOM=false] if true, removes the button's HTML from the page. */ remove(buttonAPI?: SohoButtonStatic | HTMLButtonElement | string, doRemoveDOM?: boolean): void; /** * Removes ALL buttons from the buttonset * * @param [doRemoveDOM=false] if true, removes the button's HTML from the page. */ removeAll(doRemoveDOM?: boolean): void; /** * Returns a ButtonSet API in a specified place in the buttons array. * * @param idx index to target * @returns the Button API at the given index */ at(idx: number): SohoButtonStatic; /** * Provides a JSON-compatible data representation of this button component for use with * higher-level components. * * @param addContextElement if true, adds a reference to this button element to the return data (NOT JSON-compatible). * @returns JSON-compatible representation of this button's configuration. */ toData(addContextElement: boolean): string; /** * Update the component with new settings. * * @param settings The settings you would like to modify. * @returns This component's API. */ updated(settings: SohoButtonsetOptions): SohoButtonsetStatic; /** * Teardown and remove any added markup and events. */ destroy(): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Destructor. */ ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ private markForRefresh; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoButtonsetModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /******************************************************************** * Calendar Week View Element *******************************************************************/ declare class SohoCalendarWeekViewComponent { isCalendarWeekView: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /******************************************************************** * Calendar Month View Element *******************************************************************/ declare class SohoCalendarMonthViewComponent { isCalendarMonthView: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /******************************************************************** * Main Calendar component *******************************************************************/ declare class SohoCalendarComponent implements AfterViewChecked, AfterViewInit, OnDestroy { private element; private ngZone; ref: ChangeDetectorRef; isCalendar: boolean; set calendarOptions(calendarOptions: SohoCalendarOptions | undefined); get calendarOptions(): SohoCalendarOptions | undefined; set calendarWeekOptions(calendarWeekOptions: SohoCalendarWeekOptions | undefined); get calendarWeekOptions(): SohoCalendarWeekOptions | undefined; set disable(disable: SohoDatePickerDisable); get disable(): SohoDatePickerDisable; set dayLegend(dayLegend: Array); get dayLegend(): Array; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** * An array of objects with data for the event types. */ set eventTypes(eventTypes: SohoCalendarEventType[] | undefined); get eventTypes(): SohoCalendarEventType[] | undefined; /** * An array of objects with data for the events. */ set events(events: SohoCalendarEvent[]); get events(): SohoCalendarEvent[]; set customSort(customSort: SortEvent); /** * The name of the locale to use for this instance. If not set the current locale will be used. */ set locale(locale: string); get locale(): string; /** * Initial month to show. */ set month(month: number | undefined); get month(): number | undefined; /** * Initial month to show. */ set day(day: number | undefined); get day(): number | undefined; /** * Initial year to show. */ set year(year: number | undefined); get year(): number | undefined; /** * If false the dropdown to change views will not be shown. */ set showViewChanger(showViewChanger: boolean | undefined); get showViewChanger(): boolean | undefined; /** * If false the legend will not show below. */ set showEventLegend(showEventLegend: boolean | undefined); get showEventLegend(): boolean | undefined; /** * If false the mouseover text or day event will not be shown. */ set eventTooltip(eventTooltip: string | SohoCalendarTooltipFunction); get eventTooltip(): string | SohoCalendarTooltipFunction; /** * If false the mouseover text for event icon will not be shown. */ set iconTooltip(iconTooltip: string | SohoCalendarTooltipFunction); get iconTooltip(): string | SohoCalendarTooltipFunction; /** * Fires when a month is rendered, allowing you to pass back events or event types to show. */ set renderMonthCallback(renderMonthCallback: Function); get renderMonthCallback(): Function; /** * Fires when a month day is clicked. Allowing you to do something. */ set selectedCallback(selectedCallback: Function | undefined); get selectedCallback(): Function | undefined; /** * The ID of the template used for the events. */ set template(template: string | undefined); get template(): string | undefined; /** * How many days in advance should we show in the upcoming events pane. */ set upcomingEventDays(upcomingEventDays: number | undefined); get upcomingEventDays(): number | undefined; /** * The ID of the template used for the modal dialog on events. */ set modalTemplate(modalTemplate: string | undefined); get modalTemplate(): string | undefined; /** * ID of the menu to use for an event right click context menu */ set menuId(menuId: string | undefined); get menuId(): string | undefined; /** * Callback for the right click context menu */ set menuSelected(menuSelected: Function | undefined); get menuSelected(): Function | undefined; /** * Initial event properties for the new events dialog. */ set newEventDefaults(newEventDefaults: SohoCalendarEvent | undefined); get newEventDefaults(): SohoCalendarEvent | undefined; /** * Call back for when the view changer is changed */ set changeViewCallback(changeViewCallback: Function | undefined); get changeViewCallback(): Function | undefined; /** * Deterimines if the today button should be shown. */ set showToday(showToday: boolean | undefined); get showToday(): boolean | undefined; /** * Configure date range for calendar */ set displayRange(displayRange: Object | undefined); get displayRange(): Object | undefined; /** * Configure day of week setting */ set firstDayOfWeek(day: number); get firstDayOfWeek(): number; selected: EventEmitter; monthRendered: EventEmitter; eventClick: EventEmitter; eventDblClick: EventEmitter; eventContextMenu: EventEmitter; dayClick: EventEmitter; /** * Local variables */ private jQueryElement?; private calendar?; private _calendarOptions?; private _calendarWeekOptions?; private updateRequired?; constructor(element: ElementRef, ngZone: NgZone, ref: ChangeDetectorRef); ngAfterViewInit(): void; ngAfterViewChecked(): void; onSelectedEvent(event: SohoCalendarDateSelectedEvent): void; onMonthRenderedEvent(event: SohoCalendarRenderMonthEvent): void; onEventClick(event: SohoCalendarEventClickEvent): void; onEventDblClick(event: SohoCalendarEventClickEvent): void; onEventContextMenu(event: SohoCalendarEventClickEvent): void; onEventDayClick(event: SohoCalendarDayClickEventData): void; /** * Get the current selected date on the calendar. * * @returns the currently selected date on the control. */ currentDate(): Date; /** * Get the events and date for the currently selected calendar day. * * @param date The date to find the events for. * @returns dayEvents An object with all the events and the event date. */ getDayEvents(date: Date): SohoCalendarDayEvents; /** * Add a new event via the event object and show it if it should be visible in the calendar. * * @param event The event object with common event properties. */ addEvent(event: SohoCalendarEvent): void; /** * Update an event via the event object and show it if it should be visible in the calendar. * It uses the event id to do this. * * @param event The event object with common event properties. */ updateEvent(event: SohoCalendarEvent): void; /** * Allows to update the events or event types after the calendar renders. * * @param events An array of events. * @param eventTypes An array of event types. */ updateEvents(events: SohoCalendarEvent[], eventTypes: SohoCalendarEventType[]): void; /** * Remove an event from the dataset and page. It uses the id property. * * @param event The event object with common event properties. */ deleteEvent(event: SohoCalendarEvent): void; /** * Show a modal used to add/edit events. This uses the modalTemplate setting for the modal contents. * * @param event The event object with common event properties for defaulting fields in the template. * @param done The callback for when the modal closes. */ showEventModal(event: SohoCalendarEvent[], done: Function): void; /** * @returns whether or not this Modal is currently being displayed */ modalVisible(): boolean; /** * Remove all events from the calendar */ clearEvents(): void; /** * Handle updated settings and values. */ updated(settings?: SohoCalendarOptions): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; /** * Destructor. */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCalendarModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoCardsComponent implements AfterViewInit, OnDestroy { private element; private ngZone; get isCards(): boolean; /** Reference to the Soho control api. */ private cards?; constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngOnDestroy(): void; private jQueryElement?; private options; private card?; /** Defines the data to use, must be specified for this component */ set dataset(dataset: Array | undefined); get dataset(): Array | undefined; /** Defines the selection type of cards */ set selectable(selectable: SohoCardsSelectable); get selectable(): SohoCardsSelectable; updated(settings: any): SohoCardsComponent; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardActionableComponent { get isCardActionable(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardHeaderComponent { get isCardHeader(): boolean; flex: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardContentComponent { get isCardContent(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardPaneComponent { get isCardPane(): boolean; none: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardComponent implements AfterViewInit, OnDestroy, OnInit { private element; private ngZone; id: string | undefined; expandableHeader: boolean | undefined; verticalButtonAction: boolean | undefined; autoHeight: boolean | undefined; block: string; get isCard(): boolean; get isExpandableHeader(): boolean | undefined; get isAutoHeight(): boolean | undefined; set bordered(value: boolean | string | undefined); set noHeader(value: boolean | undefined); set contentPaddingX(value: number | undefined); set contentPaddingY(value: number | undefined); set noShadow(value: boolean); set detailRefId(value: string | undefined); set closed(value: boolean | undefined); /** * Closed the state of the component */ get closed(): boolean | undefined; set attributes(value: Array | Object | undefined); get attributes(): Array | Object | undefined; /** Html template string */ set template(template: string); updated(settings: any): SohoCardComponent; toggle?: Observable; beforeexpand: EventEmitter; beforecollapse: EventEmitter; expand: EventEmitter; collapse: EventEmitter; afterexpand: EventEmitter; aftercollapse: EventEmitter; selected: EventEmitter; deselected: EventEmitter; private jQueryElement?; private options; private cards?; private _closed?; constructor(element: ElementRef, ngZone: NgZone); ngOnInit(): void; ngAfterViewInit(): void; ngOnDestroy(): void; /** * Toggles the state of the expandable card based on the passed param. */ toggleOpen(open: boolean): void; close(): void; open(): void; private onBeforeExpand; private onBeforeCollapse; private onExpand; private onCollapse; private onAfterExpand; private onAfterCollapse; private onSelected; private onDeselected; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCardModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoChartComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; set chartOptions(chartOptions: SohoChartOptions); set selectedIndex(index: number); set dataSet(dataset: SohoDataSet); set type(type: ChartTypes); set axisLabels(axisLabels: AxisLabels); set showLegend(showLegend: boolean); set hideLabels(hideLabels: boolean); set formatterString(formatterString: string); set legendFormatter(legendFormatter: string); set chartLabel(chartLabel: ChartLabel); set chartredrawOnResizeLabel(redrawOnResize: boolean); set chartAnimate(animate: boolean); selected: EventEmitter; unselected: EventEmitter; rendered: EventEmitter; /** * @todo replace override of native attribute */ contextmenu: EventEmitter; private _chartOptions; private jQueryElement?; private chart?; private updateRequired; constructor(elementRef: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; getChartOptions(): SohoChartOptions; updated(): void; getSelected(): any; setSelectRef(ref: any): void; setSelectDataIndex(selectIndex: number): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoChartModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Wrapper for soho checkboxes. * * Note the control must have type="checkbox" for the values to be passed * to and from any ng model instances. */ declare class SohoCheckBoxComponent implements AfterViewInit, OnDestroy { private elementRef; private ngZone; /** * Indicate that the checkbox is partial */ partial?: boolean; /** * Indicate that the checkbox is displayed as a switch. */ switch: boolean; /** * Bind attributes to the host input element */ get isCheckBoxType(): string; get isCheckBox(): boolean; get isPartialCheckBox(): boolean; get isPartialAriaChecked(): "mixed" | null; get isSwitch(): boolean; checked?: boolean; /** Called when the checkbox value changes. */ changeEvent: EventEmitter; /** Called when the checkbox updates in some way. */ updateEvent: EventEmitter; /** * Local variables */ private jQueryElement?; /** * Constructor. * * @param elementRef - the element matching the component's selector. */ constructor(elementRef: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; /** * Destructor. */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCheckBoxModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoCirclepagerComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private settings; get isCirclePager(): boolean; /** The number of slides to show in one view / pane. */ set slidesToShow(value: number); /** First showing slide/group, an 0-based integer */ set startingSlide(value: number); /** Setting loop: true will loop back after next/previous reached to end */ set loop(value: boolean); private jQueryElement?; private circlepager?; /** Add extra attributes like id's to the component **/ set attributes(attributes: Array | Object); private updateRequired; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; ngAfterViewChecked(): void; /** Tear Down */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoCirclepagerModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoColorPickerComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; ngControl: NgControl; ref: ChangeDetectorRef; /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; /** Value Accessor */ private valueAccessor?; /** * Local variables */ private jQueryElement; private colorpicker; private isEditable?; isUppercase?: boolean; isClearable?: boolean; private isDisabled?; private isReadOnly?; private isShowLabel?; isColorOnly?: boolean; hasCustomColor?: boolean; clearableTextString: string; private options?; /** * Indicates the color list */ set colors(colors: Array | undefined); /** * Enables or disables the control */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * Enables or disables editing */ set editable(value: boolean | undefined); get editable(): boolean | undefined; /** * Enables or disables forces upper case hex. */ set uppercase(value: boolean); /** * Enables or disables the clear option. */ set clearable(value: boolean); /** * Enables or disables the clear option. */ set customColors(value: boolean); /** * Enables or disables the colorOnly option. */ set colorOnly(value: boolean); /** * Sets the clearableText option. */ set clearableText(value: string); /** * Add extra attributes like id's to the component */ set attributes(value: Array | Object); /** * Sets the control to readonly */ set readonly(value: boolean | undefined); get readonly(): boolean | undefined; /** * Sets the control to show color label */ set showLabel(value: boolean | undefined); get showLabel(): boolean | undefined; /** * Called when the colorpicker value changes * * @todo replace override of native attribute */ change: EventEmitter; /** * Called when the colorpicker updates in some way. */ updatedEvent: EventEmitter; /** * Public API */ getLabelValue(): any; getHexValue(): any; /** * Bind attributes to the host input element */ get isColorpicker(): boolean; /** * Creates an instance of SohoColorPickerComponent. * * @param element the element this component encapsulates. * @param ngZone the angualar zone for this component * @param ngControl any associated form control (optional) * */ constructor(element: ElementRef, ngZone: NgZone, ngControl: NgControl, ref: ChangeDetectorRef); ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Event handler for the 'changed' event on the 'colorpicker' component. * * * @param event the standard jQuery event. */ private onChanged; /** * In case options are being bound asynchronously, you will need to trigger updated on * soho colorpicker control so it updates its value labels. */ updated(): SohoColorPickerComponent; onUpdated(event: JQuery.TriggeredEvent): void; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(isDisabled: boolean): void; ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoColorPickerModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoColumnComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private options; get isColumn(): boolean; /** Defines the data to use, must be specified for this component. */ set dataset(dataset: Array); /** Chart Type */ set type(value: SohoColumnType); /** Default is a single or stacked chart. */ set isStacked(value: boolean); /** If false the legend will not be shown. */ set showLegend(value: boolean); /** true|false - will do or not do the animation, 'initial' will do only first time the animation. */ set animate(value: boolean); /** If true, the component will not resize when resizing the page. */ set redrawOnResize(value: boolean); /** The d3 axis format. */ set format(value: string); set formatterString(value: string); /** Settings for the chart ticks. Can set ticks: {format: d3Format, number: n} */ set ticks(value: object); /** An empty message will be displayed when there is no chart data. */ set emptyMessage(value: SohoEmptyMessageOptions); /** Settings for the chart xAxis. */ set xAxis(value: object); /** Settings for the chart yAxis. */ set yAxis(value: object); /** Settings for the chart tooltip. */ set tooltip(tooltip: string | SohoColumnTooltipFunction); /** * Add extra attributes like id's to the component */ set attributes(attributes: Array | Object); /** * Add extra options to control axisLabels */ set axisLabels(value: any); /** * Add option to control/adjust the data group bar stacked position. */ set stackedTransformX(value: number); /** * Adds the ability to use line chart if set to true. This will need a target value to the dataset. */ set hideDots(value: boolean); set useLine(value: boolean); /** Forces decimal point to '.' on y-axis ticks regardless of locale. */ set forceDecimalPoint(value: boolean); /** Events */ selected: EventEmitter; unselected: EventEmitter; rendered: EventEmitter; dblclick: EventEmitter; /** * @todo replace override of native attribute */ contextmenu: EventEmitter; private jQueryElement?; column?: SohoColumn | null; private updateRequired; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; ngAfterViewChecked(): void; updated(): void; /** Tear Down */ ngOnDestroy(): void; setSelected(selected: SohoColumnSelected): void; toggleSelected(selected: SohoColumnSelected): void; getSelected(): Object | Object[] | undefined; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoColumnModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * SUB COMPONENT: SOHO-CONTEXT-MENU-HEADING */ declare class SohoContextMenuHeadingComponent { get isHeading(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * SUB COMPONENT: SOHO-CONTEXT-MENU-SHORTCUT-TEXT */ declare class SohoContextMenuShortCutTextComponent { get isShortCutText(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * SUB COMPONENT: SOHO-CONTEXT-MENU-SEPARATOR */ declare class SohoContextMenuSeparatorComponent { get isSeparator(): boolean; singleSelectableSection: boolean; multiSelectableSection: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * SUB COMPONENT: SOHO-CONTEXT-MENU-LABEL */ declare class SohoContextMenuItemLabelComponent { get hrefAttr(): string; menuId?: string; menuUrl?: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * SUB COMPONENT: SOHO-CONTEXT-MENU-ITEM */ declare class SohoContextMenuItemComponent { isChecked?: boolean; isSelectable: boolean; isDisabled: boolean; isIndented: boolean; subMenu: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * MAIN DIRECTIVE: SOHO-CONTEXT-MENU */ declare class SohoContextMenuDirective implements AfterViewInit, OnDestroy { private element; private ngZone; private jQueryElement?; private contextMenu?; private options; selected: EventEmitter; beforeopen: EventEmitter; /** * @todo replace override of native attribute */ open: EventEmitter; closeEvent: EventEmitter; set trigger(trigger: SohoPopupMenuTrigger); set menu(menu: string); /** Auto Focus */ set autoFocus(autoFocus: boolean); get autoFocus(): boolean; /** Mouse focus. */ set mouseFocus(mouseFocus: boolean); get mouseFocus(): boolean; /** Attach to body. */ set attachToBody(attachToBody: boolean); get attachToBody(): boolean; set placementOpts(placementOpts: SohoPopupmenuPlacementOpts); get placementOpts(): SohoPopupmenuPlacementOpts; set offset(offset: SohoPopupmenuOffset); get offset(): SohoPopupmenuOffset; listOffset: SohoPopupmenuOffset; set removeOnDestroy(removeOnDestroy: boolean); get removeOnDestroy(): boolean; /** beforeOpen - ajax callback for open event */ set beforeOpen(beforeOpen: SohoPopupMenuSourceFunction); get beforeOpen(): SohoPopupMenuSourceFunction; /** beforeOpen - ajax callback for open event */ lazyLoad: boolean; constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; private init; onContextMenu(e: JQuery.TriggeredEvent, api: any): void; updated(): void; teardown(): void; /** * Closes the popup menu * * @param isCancelled Internally set option used if the operation is a cancel. * Wont matter for manual api call. * @param noFocus Do not return focus to the calling element (fx a button) */ close(isCancelled?: boolean, noFocus?: boolean): void; ngOnDestroy(): void; initializeComponent(eventObj?: any): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoContextMenuModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoContextualActionPanelModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Wrapper for the jQuery panel control. * */ declare class SohoContextualActionPanelRef { private appRef; private injector; private ngZone; /** Component - if the content is derived from an existing component. */ private componentRef?; /** Selector referencing the panel-panel after it has been moved to the panel container. */ private jQueryElement?; /** Soho Control Api */ private contextualactionpanel?; /** The result of the panel. */ private _panelResult; /** Event fired when the panel is opened. */ private open$; /** Event fired when the panel is closed. */ private close$; /** Event fired before closing the panel */ private beforeClose$; /** Event fired after closing the panel. */ private afterClose$; /** Event fired before opening the panel. */ private beforeOpen$; /** Event fired after opening the panel. */ private afterOpen$; /** Handle resource tidy up of this class. */ private destroyed$; /** * The component displayed as the panel content. * * @param componentRef - reference to the component defining the panel panel content. */ set component(componentRef: ComponentRef); /** * The component displayed inside the panel's frame, if specified. This may * be null if the component is built from an HTML fragment or a jQuery selector. */ get componentPanel(): T | null; /** * The buttonset API for the CAP dialog. * * @returns the buttonset API for the CAP dialog, if initialized. */ get buttonsetAPI(): SohoButtonsetStatic | undefined; /** * The toolbar API for the CAP dialog. * * @returns the toolbar API for the CAP dialog, if initialized. */ get toolbarAPI(): SohoToolbarStatic | SohoToolbarFlexStatic | undefined; /** * Cached options. */ private _options; /** * Sets the whole options block for this contextual action panel. * * @param options - the options to set. */ options(options: SohoContextualActionPanelOptions): SohoContextualActionPanelRef; /** * Sets the whole options block for this contextual action panel. * * @param modalSettings - the options to set. */ modalSettings(modalSettings: SohoModalOptions): SohoContextualActionPanelRef; /** * Ability to add class(es) to the parent CAP element. * * @param cssClass - the class(es) value to add in CAP element. */ cssClass(cssClass: string): this; /** Add extra attributes like id's to the component **/ attributes(attributes: Array | Object): SohoContextualActionPanelRef; /** * Sets the title of the panel. * * @param title - the title of the panel. */ title(title: string): SohoContextualActionPanelRef; /** * Sets the id of the detail element that will be used to display the detail content. * * @param detailRefId - the id of the content. */ detailRefId(detailRefId?: string | undefined): SohoContextualActionPanelRef; /** * Sets the buttons to use on the panel panel. * * @deprecated (use modalSettings) * @param buttons - list of buttons to display */ buttons(buttons: SohoContextualActionPanelButton[]): SohoContextualActionPanelRef; /** * Sets the 'id' that the panel control uses. * * @deprecated (use modalSettings) * @param id - the id. */ id(id: string): SohoContextualActionPanelRef; /** * Sets the 'id' that the panel control uses. * * @param initializeContent - Sets the ability to initialize content. */ initializeContent(initializeContent: boolean): SohoContextualActionPanelRef; /** * Sets the 'centerTitle' that the panel control uses. * * @deprecated (use modalSettings) * @param centerTitle - Aligns title to center */ centerTitle(centerTitle: boolean): SohoContextualActionPanelRef; /** * Sets the `noSaveButton` to remove the save button in the toolbar. * @param noSaveButton - if true, remove the save button */ noSaveButton(noSaveButton: boolean): SohoContextualActionPanelRef; /** * Sets the 'trigger' that the panel control uses. * * @deprecated (use modalSettings) * @param trigger - when to open the panel. */ trigger(trigger: SohoContextualActionPanelTriggerType): SohoContextualActionPanelRef; /** * Sets the 'content' that the panel control uses. * * @param content - a selector or string representing the panel content. */ content(content: JQuery | string): SohoContextualActionPanelRef; /** * Applies a function to the instantiated component, * allowing the component to be modified, or initialised. * * The function is provided with a typed value for the * instance. * * @param component - the instantiated instance. * @return the panel ref for onward assignment. */ apply(fn: (component: T) => void): SohoContextualActionPanelRef; /** * panel result property. * * @param panelResult - the stored result of the panel. */ set panelResult(panelResult: any); get panelResult(): any; /** * Constructor. */ constructor(appRef: ApplicationRef, componentFactoryResolver: ComponentFactoryResolver, injector: Injector, ngZone: NgZone, settings: SohoContextualActionPanelOptions, panelComponent?: PanelComponentType); /** * Opens the panel. * * @return the panel ref. */ open(): SohoContextualActionPanelRef; /** * Closes the panel, if open. The panel is not closed * fully until the 'afterClosed' event is fired. * * @param panelResult - optional result - passed back to the caller. * @param doForce - optional - forces the modal to close. */ close(panelResult?: any, doForce?: boolean): SohoContextualActionPanelRef; /** * Opened Event. * * This event is fired when the panel is being opened. * * @param eventFn - the function to invoke when the panel is to be opened. */ opened(eventFn: Function): SohoContextualActionPanelRef | null; /** * Opened Event. * This event is fired after the panel has been opened. * * @param eventFn - the function to invoke when the panel is to be opened. */ afterOpen(eventFn: Function): SohoContextualActionPanelRef | null; /** * Opened Event. * This event is fired after the panel has been opened. * * @param eventFn - the function to invoke when the panel is to be opened. */ beforeOpen(eventFn: Function): SohoContextualActionPanelRef | null; /** * Before Closed Event. * This event is fired before closing the panel. * * @param eventFn - the function to invoke when the panel before closing. */ beforeClose(eventFn: Function): SohoContextualActionPanelRef | null; /** * Closed Event. * * This event is fired when the panel is being closed. * * @param eventFn - the function to invoke when the panel is to be closed. */ closed(eventFn: SohoContextualActionPanelEventFunction): SohoContextualActionPanelRef | null; /** * After Closed Event. * * This event is fired, with the result of the panel, when the panel has been * closed and destroyed. * * @param eventFn - the function to invoke after the panel has been closed. */ afterClose(eventFn: SohoContextualActionPanelEventFunction | null): SohoContextualActionPanelRef | null; /** * Handles the 'open' event, fired just before * the focus is assigned to a panel. * * @param event - full event object. */ private onOpen; /** * Handles the 'afterOpen' event, fired after the panel panel * has been opened. * * @param event - full event object. */ private onAfterOpen; /** * Handles the 'afterOpen' event, fired after the panel panel * has been opened. * * @param event - full event object. */ private onBeforeOpen; /** * Handles the close event. * * @param event - full event object. * @param isCancelled - is true if the cancel button was pressed; otherwise false. */ private onClose; /** * Handles the 'afterClose' event, fired when th panel * has been closed and tidy up is required. * * @param event - full event object. */ private onAfterClose; /** * Handles the 'beforeclose' event. * * @param event - full event object. */ private onBeforeClose; } /** * Close/AfterClose event handler. * * @param result - the panel result (if set); may be undefined. * @param panelRef - the panel reference (or wrapper); never null. * @param panelComponent - the component hosted in the modal; may be undefined. */ type SohoContextualActionPanelEventFunction = (result: any, panelRef: SohoContextualActionPanelRef, panelComponent: T) => void; /** * Contract for all SohoContextualActionPanelComponents. */ interface SohoContextualActionPanelComponent { } /** * This service is used to create a panel panel, based on the content * of an Angular Component on the screen. */ declare class SohoContextualActionPanelService { private readonly appRef; private readonly componentFactoryResolver; private readonly injector; private readonly ngZone; /** * Constructor. * * @param appRef - application reference; must not be null. * @param componentFactoryResolver - used to create component factories for components dynamically. * @param injector - the current in scope injector, use as a delegate. * @param ngZone - the angular zone; must not be null. */ constructor(appRef: ApplicationRef, componentFactoryResolver: ComponentFactoryResolver, injector: Injector, ngZone: NgZone); /** * Creates a panel defined by the given component, returning a reference to the * panel that can be interacted with. * * The component has the potential to include the panel reference when it is * instantiated, as a provider. * * The panel won't necessarily be open yet, see the panel ref Api for further methods. * * @param component - the type of the component to instantiate; must not be null. * @param _parent - The parent container; obsolete but parameter kept for backwards API compatibility. Has no effect. * @param options - the default options for the panel; optional. * * @return the panel reference. */ contextualactionpanel(component: PanelComponentType, _parent?: ViewContainerRef, options?: SohoContextualActionPanelOptions): SohoContextualActionPanelRef; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * Object with a "new"" method returning the type T. */ type PanelComponentType = new (...args: any[]) => T; /** * Dynamic Soho Data Grid Service contract. */ declare abstract class SohoDataGridService { /** * Returns the columns to use for the data grid. */ abstract getColumns(): SohoDataGridColumn[]; /** * Returns a list of data rows. * * @todo implement pagingpaging * * @param gridRequest -used to define the data to return. */ abstract getData(req: SohoDataGridSourceRequest | undefined | null): Observable; } type SohoDataGridType = 'auto' | 'content-only'; /** * Contract for cell editors. */ interface ExtendedSohoDataGridCellEditor extends SohoDataGridCellEditor { component: Type; args: SohoDataGridEditCellFunctionArgs; input?: JQuery; useValue: boolean; className?: string; /** * Initialise the edit control with the given component. The control * mist conform to the SohoDataGridCellEditor contract. */ init(componentRef: ComponentRef): void; /** * Destroy the editor. */ destroy(): void; } declare class SohoAngularEditorAdapter implements ExtendedSohoDataGridCellEditor { component: Type; args: SohoDataGridEditCellFunctionArgs; componentRef?: ComponentRef | null; input?: JQuery; useValue: boolean; className?: string; constructor(component: Type, args: SohoDataGridEditCellFunctionArgs); init(componentRef: ComponentRef): void; val(value?: any): any; focus(): void; destroy(): void; } /** * Angular Wrapper for the Soho Data Grid Component. * * This component searches for an element with the attribute * 'soho-datagrid' in the parent's DOM tree, initialising it with * the Soho datagrid control. * * The data is provided either by a component input or an implementation * of the DataGridService interface, by specifying an implementation * on the hosting component, i.e. * * providers: [ provide: DataGridService, useClass: DataGridDemoService} ] */ declare class SohoDataGridComponent implements OnInit, AfterViewInit, OnDestroy, AfterViewChecked { private ngZone; private elementRef; private changeDetector; private resolver; private injector; private app; protected datagridService: SohoDataGridService; static AUTO: SohoDataGridType; static CONTENT_ONLY: SohoDataGridType; /** * Sets the grid options for the data grid, marking this components * as requiring a full rebuild at the end of the change lifecycle. * * @param gridOptions - not null grid options. */ set gridOptions(gridOptions: SohoDataGridOptions); get gridOptions(): SohoDataGridOptions; /** * Defines which property in the data rows is to be used as the id of each * row of the data. * * @param idProperty string id */ set idProperty(idProperty: string | undefined); get idProperty(): string | undefined; /** * If true, shows an icon next to ellipsis text to indicate more content. * * @param ellipsisWithIcon boolean */ set ellipsisWithIcon(ellipsisWithIcon: boolean | undefined); get ellipsisWithIcon(): boolean | undefined; /** * Sets the aria label for the datagrid table element * @param ariaLabel string */ set ariaLabel(ariaLabel: string | undefined); get ariaLabel(): string | undefined; /** * The value of the frozenColumns option - returns the requested * value if the control has not been created yet. */ get frozenColumns(): SohoDataGridFrozenColumns | undefined; /** * Sets the frozenColumns settings - will force a grid rebuild if the component has already been * created. * * @param frozenColumns - the frozenColumns settings. */ set frozenColumns(frozenColumns: SohoDataGridFrozenColumns | undefined); /** * If true allows */ set cellNavigation(cellNavigation: boolean | undefined); get cellNavigation(): boolean | undefined; get isVerticalScrollToEnd(): boolean | undefined; /** * Changes the row navigation setting of the data grid. If rowNavigation * is "false” then a border is not displayed around the row. * * Defaults to true. * * @param rowlNavigation i "false” then grid will NOT show a border around the row. */ set rowNavigation(rowNavigation: boolean | undefined); get rowNavigation(): boolean | undefined; /** * If true, displays the rows in the grid using alternate shading, otherwise * all the rows use the same shading. */ set alternateRowShading(alternateRowShading: boolean | undefined); get alternateRowShading(): boolean | undefined; /** * The data to be displayed provided as an array * of json objects compatible with the column meta * data provided. * * @param dataset - array of json objects */ set dataset(dataset: Array | undefined); /** * Return the dataset currently displayed by the datagrid. * * @return an array of objects. */ get dataset(): any[] | undefined; /** * If true the columns can be reorders; otherwise if false they are fixed. */ set columnReorder(columnReorder: boolean | undefined); get columnReorder(): boolean | undefined; set disableClientSort(disableClientSort: boolean | undefined); get disableClientSort(): boolean | undefined; set allowTriStateSort(allowTriStateSort: boolean | undefined); get allowTriStateSort(): boolean | undefined; set disableClientFilter(disableClientFilter: boolean | undefined); get disableClientFilter(): boolean | undefined; set resultsText(resultsText: SohoDataGridResultsTextFunction); set showFilterTotal(showFilterTotal: boolean | undefined); get showFilterTotal(): boolean | undefined; /** * If true, the grid allows edits, otherwise if false edits are disabled. */ set editable(editable: boolean | undefined); get editable(): boolean | undefined; /** * Input that defines a function which is used to determine if a row is disabled, or not. */ set isRowDisabled(isRowDisabled: SohoIsRowDisabledFunction | undefined); get isRowDisabled(): SohoIsRowDisabledFunction | undefined; set allowOneExpandedRow(allowOneExpandedRow: boolean | undefined); get allowOneExpandedRow(): boolean | undefined; set rowTemplate(rowTemplate: string | undefined); get rowTemplate(): string | undefined; set rowTemplateComponent(rowTemplateComponent: any); get rowTemplateComponent(): any; set rowTemplateComponentInputs(rowTemplateComponentInputs: any); get rowTemplateComponentInputs(): any; set rowTemplateField(rowTemplateField: string | undefined); get rowTemplateField(): string | undefined; /** * If true, will select the cell text soon as entering edit mode */ set selectOnEdit(selectOnEdit: boolean | undefined); get selectOnEdit(): boolean | undefined; set isList(isList: boolean | undefined); get isList(): boolean | undefined; set menuId(menuId: any); /** beforeOpen - ajax callback for open event */ set menuBeforeOpen(menuBeforeOpen: SohoPopupMenuSourceFunction); get menuBeforeOpen(): SohoPopupMenuSourceFunction; /** * Sets the row height for the grid, to be one of the supported options. * * @param rowHeight - 'extra-small' | 'small' | 'medium' | 'large' */ set rowHeight(rowHeight: SohoDataGridRowHeight); /** * Sets the height of the row to something other then the three built in rowHeights. * * @param fixedRowHeight Any integer */ set fixedRowHeight(fixedRowHeight: number | string | Function); /** * Whether selection is enabled. * * @param selectable valid values are: 'multiple', 'single', 'mixed', 'siblings' and false. */ set selectable(selectable: any); get selectable(): any; set showSelectAllCheckBox(showSelectAllCheckBox: boolean | undefined); get showSelectAllCheckBox(): boolean | undefined; set clickToSelect(clickToSelect: boolean | undefined); get clickToSelect(): boolean | undefined; set toolbar(toolbar: SohoToolbarOptions); set initializeToolbar(initializeToolbar: boolean | undefined); get initializeToolbar(): boolean | undefined; set saveUserSettings(settingsForSave: SohoDataGridSaveUserSettings); set paging(paging: boolean | undefined); get paging(): boolean | undefined; set pagesize(pagesize: number); set pagesizes(pagesizes: Array); set indeterminate(indeterminate: boolean); set actionableMode(actionableMode: boolean | undefined); get actionableMode(): boolean | undefined; set saveColumns(saveColumns: boolean); /** * Input for the source function. * * @param source the dataset's source function. */ set source(source: SohoDataGridSourceFunction | undefined); /** * Enables or disables the filter bar on the grid. * * @param filterable if true, the filter bar is displayed; otherwise no filter bar is displayed. */ set filterable(filterable: boolean | undefined); get filterable(): boolean | undefined; set filterWhenTyping(filterWhenTyping: boolean | undefined); get filterWhenTyping(): boolean | undefined; /** * If true the datagrid is displayed as a tree, otherwise * the grid is displayed as flat rows. * * This field is dynamic, and will cause the grid to be rebuilt * if changed. * * @param treeGrid - boolean flag indicating if the data is hierarchical. */ set treeGrid(treeGrid: boolean | undefined); get treeGrid(): boolean | undefined; /** * Returns the unqiue identifier; which may be undefined. */ get uniqueId(): string | undefined; /** * Sets the unqiueId - will force a grid rebuild if the component has already been * created. * * @param unqiueId - the new id. */ set uniqueId(uniqueId: string | undefined); /** * The value of the rowReorder flag - returns the requested value if the control has not been created yet. */ get rowReorder(): boolean | undefined; /** * Sets the rowReorder flag - will force a grid rebuild if the component has already been * created. * * @param rowReorder - if true the rows will be reorderable; otherwise they will not. */ set rowReorder(value: boolean | undefined); /** * The value of the showDirty flag - returns the requested value if the control has not been created yet. */ get showDirty(): boolean | undefined; /** * Sets the showDirty flag - will force a grid rebuild if the component has already been * created. * * @param showDirty - if true then dirty rows will be highlighted; otherwise they will not. */ set showDirty(value: boolean | undefined); /** * The value of the addCellLayoutClass flag. */ get addCellLayoutClass(): boolean | undefined; /** * Sets the addCellLayoutClass flag - If set false, will remove datagrid-cell-layout class from expandable rows. * created. * * @param addCellLayoutClass - if true then dirty rows will be highlighted; otherwise they will not. */ set addCellLayoutClass(value: boolean | undefined); /** * Sets the resizeMode option to changes the column resize behavior. * * @param resizeMode - if true then dirty rows will be highlighted; otherwise they will not. */ set resizeMode(value: SohoDataGridResizeMode | undefined); /** * Sets the datagrid header background color, either dark or light. * @param headerBackgroundColor - default value is 'dark' */ set headerBackgroundColor(value: SohoDatagridHeaderBackgroundColor | undefined); set headerMenuId(value: string | undefined); get headerMenuId(): string | undefined; set headerMenuSelected(headerMenuSelected: Function); set headerMenuBeforeOpen(headerMenuBeforeOpen: Function); get disableRowDeactivation(): boolean | undefined; set disableRowDeactivation(value: boolean | undefined); get disableRowDeselection(): boolean | undefined; set disableRowDeselection(value: boolean | undefined); /** * Used to hold an object that can be referenced in formatters * and editors or anywhere else a datagrid reference is available */ set userObject(userObject: any | undefined); get userObject(): any | undefined; /** * The value of the groupable option - returns the requested * value if the control has not been created yet. */ get groupable(): SohoDataGridGroupable | undefined; /** * Sets the groupable settings - will force a grid rebuild if the component has already been * created. * * @param groupable - the groupable settings. */ set groupable(value: SohoDataGridGroupable | undefined); /** * The array of data to display in the grid. * * @param an array of objects matching the column definition. * * As this method can be called before the control is * initialised, stash the data for later, and only * call loadData on the control api if ready. */ set data(data: any[] | undefined); /** * The array of columns to display in the grid. * * As this method can be called before the control is * initialised, stash the data for later, and only * call loadData on the control api if ready. */ set columns(columns: SohoDataGridColumn[] | undefined); /** * * Summary row columns settingss */ set summaryRowColumns(summaryRowColumns: SohoDataGridSummaryRowColumnSettings[]); /** * If true an extra column will be added to the end that fills the space. * This allows columns to not stretch to fill so they are a constant size. * This setting cannot be used with percent columns. */ set spacerColumn(spacerColumn: boolean | undefined); /** * If true an extra column is currently added to the end that fills the space. */ get spacerColumn(): boolean | undefined; set sizeColumnsEqually(sizeColumnsEqually: boolean | undefined); get sizeColumnsEqually(): boolean | undefined; set expandableRow(expandableRow: boolean | undefined); get expandableRow(): boolean | undefined; set redrawOnResize(redrawOnResize: boolean | undefined); get redrawOnResize(): boolean | undefined; set exportConvertNegative(exportConvertNegative: boolean | undefined); get exportConvertNegative(): boolean | undefined; set overrideTabbing(overrideTabbing: boolean | undefined); get overrideTabbing(): boolean | undefined; set headerTabStops(headerTabStops: boolean | null | undefined); get headerTabStops(): boolean | null | undefined; set suppressNonInteractiveFocus(suppressNonInteractiveFocus: boolean | undefined); get suppressNonInteractiveFocus(): boolean | undefined; set showEditorIcons(showEditorIcons: boolean | undefined); get showEditorIcons(): boolean | undefined; set stickyHeader(stickyHeader: boolean); set attributes(attributes: Array | Object); /** * Determines the sizing method for the auto sizing columns. */ set columnSizing(columnSizing: 'both' | 'data' | 'header' | undefined); /** * Determines the sizing method for the auto sizing columns. */ get columnSizing(): 'both' | 'data' | 'header' | undefined; /** * The name of the column stretched to fill the width of the datagrid, * or 'last' where the last column will be stretched to fill the * remaining space. * * @param stretchColumn - the name of the column to stretch; or 'last', */ set stretchColumn(stretchColumn: string | undefined); /** * The name of the column to stretch, or 'last' if the * last column is stretched. */ get stretchColumn(): string | undefined; /** * If true, column will recalculate its width and stretch if required on column change. * * @param stretchColumnOnChange - If false stretch logic wont run on column change. */ set stretchColumnOnChange(stretchColumnOnChange: boolean | undefined); /** * The current value of stretchColumnOnChange. */ get stretchColumnOnChange(): boolean | undefined; /** * Whether to show the page size selector or not. */ set showPageSizeSelector(showPageSizeSelector: boolean); /** * If true, hides the pager if there's only one page worth of results. */ set hidePagerOnOnePage(hidePagerOnOnePage: boolean); /** * The column groups * * As this method can be called before the control is * initialised, stash the data for later, and only * call loadData on the control api if ready. */ set columnGroup(columnGroups: SohoDataGridColumnGroup[]); get columnGroup(): SohoDataGridColumnGroup[]; /** * The `emptyMessage` data grid option. * Use null or undefined to remove any empty message. */ set emptyMessage(emptyMessage: SohoEmptyMessageOptions | null | undefined); get emptyMessage(): SohoEmptyMessageOptions | null | undefined; /** * Enable toolips on the cell values, at a cost of performance. */ set enableTooltips(value: boolean | undefined); get enableTooltips(): boolean | undefined; set selectChildren(selectChildren: boolean | undefined); get selectChildren(): boolean | undefined; set allowChildExpandOnMatch(allowChildExpandOnMatch: boolean | undefined); get allowChildExpandOnMatch(): boolean | undefined; /** * Defines the source type of the grid, either: * * - "content-only" where table elements are provided in the body. * - "auto" where columns and rows are obtained for an * injected service (if defined) or via the Inputs if not. * * Allow the input to be overriden, to match the component selector. */ set sohoDatagrid(datagridType: SohoDataGridType | '' | undefined | null); selected: EventEmitter; deselected: EventEmitter; cellchange: EventEmitter; rowRemove: EventEmitter; rowAdd: EventEmitter; filtered: EventEmitter; expandrow: EventEmitter; /** * This event is fired when a key is pressed * * @todo remove override of native attribute */ keydown: EventEmitter; exiteditmode: EventEmitter; beforeentereditmode: EventEmitter; /** * This event is fired when edit mode is entered. */ entereditmode: EventEmitter; collapserow: EventEmitter; sorted: EventEmitter; searched: EventEmitter; nextPage: EventEmitter; previousPage: EventEmitter; firstPage: EventEmitter; lastPage: EventEmitter; pageSizeChange: EventEmitter; beforePaging: EventEmitter; afterPaging: EventEmitter; beforeRowActivated: EventEmitter; rowActivated: EventEmitter; columnChange: EventEmitter; rowDeactivated: EventEmitter; rowClicked: EventEmitter; rowDoubleClicked: EventEmitter; contextMenu: EventEmitter; rowReordered: EventEmitter; openFilterRow: EventEmitter; closeFilterRow: EventEmitter; settingsChanged: EventEmitter; rendered: EventEmitter; afterRender: EventEmitter; verticalScroll: EventEmitter; filteroperatorchanged: EventEmitter; isDisabled: boolean; /** * Sets the role for the grid. */ get datagridRole(): "treegrid" | "datagrid"; private jQueryElement?; private datagrid?; private gridData?; private datagridType?; private _gridOptions; private refreshHint; private changedOptions; private cellComponents; private rowTemplateComponents; /** * Constructor. * * @param ngZone - the angular zone for this component. * @param elementRef - the element matching the component's selector. * @param changeDetector - the component's change detector. * @param resolver - component factory resolver (for editors/formatters). * @param injector - dynamic component injector (for editors/formatters). * @param datagridService - service for obtaining data (optional) */ constructor(ngZone: NgZone, elementRef: ElementRef, changeDetector: ChangeDetectorRef, resolver: ComponentFactoryResolver, injector: Injector, app: ApplicationRef, datagridService: SohoDataGridService); getColumnGroup(idx: number): string; getColumnById(idx: number): string; /** * Overrides the sort function used by the datagrid, * can only be used once the grid has been created. * * @todo this should made lazy. */ setSortFunction(sortFunction: SohoDataGridSortFunction): void; /** * Sets the column and direction to sort the dataset on. * * Can only be used once the grid has been initialised, otherwise * an error is thrown. * * @param columnId the id of the column to sort on; must be non-null. * @param ascending if true sort ascending, otherwise descending. If not supplied the setting is toggled. */ setSortColumn(columnId: string, ascending?: boolean): void; /** * Used to set the sort indicator on a column when disableClientSort is set to true. */ setSortIndicator(columnId: string, ascending: boolean | undefined | null): void; pageSize(): number | undefined; updatePagingInfo(pageInfo: SohoPagerPagingInfo): void; enable(): void; disable(): void; updateRow(idx: number, row: any): void; hideColumn(id: any): void; showColumn(id: any): void; columnById(id: string): Array; getColumns(): Array; getColumnGroups(): SohoDataGridColumnGroup[]; /** Get the column index from the col's id */ columnIdxById(columnId: string): number; getHeaderRowColumn(fld: any): any; /** * Adds a row of data to the datagrid at the given optional location. * * @param data the row of data to add. * @param location the optional location, 'top' or 'bottom' or a number. */ addRow(data: any, location?: 'top' | 'bottom' | number): void; /** * Adds multiple rows of data to the datagrid at the given optional location. * @param data Array of data to add. * @param location the optional location, 'top' or 'bottom' or a number. */ addRows(data: any[], location?: 'top' | 'bottom' | number): void; /** * Removes a row matching the rowIndex passed in from the data and grid. * * @param rowIndex the index of the row to remove. */ removeRow(rowIndex: number, noSync?: boolean, noTrigger?: boolean): void; /** * Returns an array of the dirty rows in the grid. * * @return an array of the dirty rows in the grid. */ dirtyRows(): Array; /** * Returns an array of the dirty cells in the grid. * * @return an array of the dirty cells in the grid. */ dirtyCells(): Array; /** * Clear all dirty cells. */ clearDirty(): void; /** * Commit the cell that's currently in edit mode. */ commitCellEdit(): void; /** * Clear all dirty cells in given row. * * @param row - the row number (idx) of the row. */ clearDirtyRow(row: number): void; /** * Clear dirty on given cell. * * @param row - the row number (idx) of the row * @param cell - the cell number (idx) of the cell */ clearDirtyCell(row: number, cell: number): void; /** * Clear all error for a given cell in a row * * @param row The row index. * @param cell The cell index. */ clearAllCellError(row: number, cell: number): void; /** * Clear a cell with an error of a given type * * @param row The row index. * @param cell The cell index. * @param type of error. */ clearCellError(row: number, cell: number, type: any): void; /** * Clear a row level all errors, alerts, info messages * * @param row The row index. */ clearRowError(row: number): void; /** * Clear all errors, alerts and info messages in entire datagrid. */ clearAllErrors(): void; /** Validate all rows and cells in the entire grid if they have validation on the column */ showRowError(row: number, message: string, type: SohoAlertType): void; /** Validate all cells in a specific row */ validateRow(row: number): void; /** * Set and show a message/error on the given row. */ validateAll(): void; /** * Sets the status of a given row in the grid. * * @param idx - the row number (idx) of the row * @param status - status class name e.g. 'error' * @param tooltip - string value for tooltip message e.g. 'Error' */ rowStatus(idx: number, status: string, tooltip: string): void; /** * Return an array containing all of the currently modified rows, the type of modification * and the cells that are dirty and the data. * * @returns An keyed object showing the dirty row info. */ getModifiedRows(): SohoDataGridModifiedRows; /** * Set a cell to dirty and add the dirty icon visually. * * @param row The row index * @param cell The cell index * @param toggle True to set it and false to remove it * @param data Adds dirty data to the internal tracker */ setDirtyIndicator(row: number, cell: number, toggle: boolean, data?: object): void; /** * Removes all selected rows */ removeSelected(): void; /** * Toggles the display of the filter row. */ toggleFilterRow(): void; /** * Accept conditions from outside or pull from filter row */ applyFilter(conditions?: Array): void; /** * Set the filter row from passed data / settings */ setFilterConditions(conditions: Array): void; /** * Get filter conditions in array form from the UI */ filterConditions(): Array; /** * Clears any filter defined, for this datagrid. */ clearFilter(): void; /** * Hides the contextual toolbar. */ hideContextualToolbar(): void; /** * Returns the rows currently selected on the data grid. * * @return an array of SohoDataGridSelectedRow instances. * @deprecated use selectedRows instead. */ getSelectedRows(): SohoDataGridSelectedRow[]; /** * Returns the rows currently selected on the data grid. * * @return an array of SohoDataGridSelectedRow instances. */ selectedRows(): SohoDataGridSelectedRow[]; /** * Selects all the rows in the grid. */ selectAllRows(): void; /** * Unselects all the rows in the grid. */ unSelectAllRows(): void; /** * Sets the selected status of the specified row in the data grid. * * @param idx - the row number (idx) of the row to select. * @deprecated - use selectRows instead. */ selectRow(idx: number): void; /** * Deselects the specified row in the data grid. * * @param idx - the row number (idx) of the row to deselect. */ unselectRow(idx: number): void; /** * Selects a range of rows based on the provided row indexes. * * @param start - the start index * @param end - then end index */ selectRange(start: number, end: number): void; /** * Set the selected rows by passing the row index or an array of row indexes */ selectRows(row: number | number[]): void; /** * Set the status of the checkbox on the header. * * @param state 'all', 'partial' or 'all'. */ setHeaderCheckboxState(state: SohoDataGridHeaderCheckboxState): void; /** * Activate the row of the passed-in idx. * NOTE: valid only when selection mode is 'mixed' */ activateRow(idx: number): void; /** * Deactivate the currently activated row. * * NOTE: valid only when selection mode is 'mixed' */ deactivateRow(): void; /** * Get the currently activated row. * NOTE: valid only when selection mode is 'mixed' */ activatedRow(): SohoDataGridRowActivated; /** * Sets the active cell. * * @param rowIndex The index of the row of the cell to set active. * @param cellNumber The index of the cell to set active. * @param nodeFocus If true, will focus on cell even if offscreen. */ setActiveCell(rowIndex: number, cellNumber: number, nodeFocus?: boolean): void; /** * Gets the active cell info */ getActiveCell(): any; /** * Scrolls the row at idx into view in the view port. * * @param idx The index of the row to scroll into view. */ scrollRowIntoView(idx: number): void; /** * Returns an array of row numbers for the rows containing the value for the specified field. * * @param fieldName The field name to search. * @param value The value to use in search. */ findRowsByValue(fieldName: string, value: any): number[]; /** * Programmatically trigger a call to the datagrid.settings.source * function with the given pagerType. * * @param pagerType - a valid pager type. */ triggerSource(pagerType: SohoDataGridTriggerSourcePagerType, callback?: Function): void; /** * Trigger export of grid data to Excel. * * @param fileName The prefix name to be used for the exported file. * @param worksheetName The name to be used for the worksheet. * @param customDs A datasource to override the default (deprecated) */ exportToExcel(fileName: string, worksheetName?: string | undefined, customDs?: Object[]): void; /** * Trigger export of grid data to CSV formatted file. * * @param fileName The prefix name to be used for the exported file. * @param customDs A datasource to override the default. * @param separator The separator to use in the cvs file, defaults to 'sep=,' * @param format if true, date and number values will be formatted based on the locale */ exportToCsv(fileName: string, customDs?: Object[], separator?: object | string, format?: boolean): void; /** * Trigger export of grid data to Excel format. * * @param fileName The prefix name to be used for the exported file. * @param keepGridFormatting Whether to keep grid formatting (defaults to true) */ exportToXlsx(fileName: string, keepGridFormatting?: boolean): void; /** * Updates the columns and columnGroups displayed on the grid. * * @param columns The datagrid columns to update. * @param columnGroups The column groups to update. */ updateColumns(columns: SohoDataGridColumn[], columnGroups: SohoDataGridColumnGroup[]): void; /** * Parse a JSON array with columns and return the column object. * * @param columnStr The json represntation of the column object. * @return The array of columns. */ columnsFromString(columns: string): Object; /** * Reset columns to their defaults (used on restore menu item). */ resetColumns(): void; /** * Open the personalize dialog. */ personalizeColumns(): void; /** * Restore the user settings from local Storage or as passed in. * * @param settings The object containing the settings to use. */ restoreUserSettings(settings: any): void; /** * Search a term across all columns and highlight it * @param term - the search term */ keywordSearch(value: string): void; /** * Handle a request to load the data for the grid from the service. * * @todo paging - not yet fully implemented? */ private onDataRequest; /** * Event fired after a child row has been expanded. */ private onExpandRowHandler; /** * Build component for rowTemplate */ private buildRowTemplateComponent; /** * Event fired after a context menu is opened */ private onKeyDownHandler; /** * Event fired after a child row has been expanded. * * @param idProperty string id */ set onBeforeSelect(beforeSelectFunction: SohoDataGridBeforeSelectFunction | undefined); get onBeforeSelect(): SohoDataGridBeforeSelectFunction | undefined; /** * Makes it possible to save selections when changing pages on server side paging. * You may want to also use showSelectAllCheckBox: false */ set allowSelectAcrossPages(allowSelectAcrossPages: boolean | undefined); get allowSelectAcrossPages(): boolean | undefined; /** * Select all will effect only on current page and its for client side paging only. */ set selectAllCurrentPage(selectAllCurrentPage: boolean | undefined); get selectAllCurrentPage(): boolean | undefined; /** * An array of column IDs used to define aria descriptors for selection checkboxes. */ set columnIds(columnIds: Array | undefined); get columnIds(): Array | undefined; /** *If true, the new row indicator will display after adding a row * * @param showNewRowIndicator boolean show new indicator setting */ set showNewRowIndicator(showNewRowIndicator: boolean | undefined); get showNewRowIndicator(): boolean | undefined; set onExpandChildren(expandChildrenFunction: SohoDataGridExpandChildrenFunction | undefined); get onExpandChildren(): SohoDataGridExpandChildrenFunction | undefined; set onCollapseChildren(collapseChildrenFunction: SohoDataGridCollapseChildrenFunction | undefined); get onCollapseChildren(): SohoDataGridCollapseChildrenFunction | undefined; set onPostRenderCell(onPostRenderCell: SohoDataGridPostRenderCellFunction); set onDestroyCell(onDestroyCell: SohoDataGridPostRenderCellFunction); set onEditCell(onEditCell: SohoDataGridEditCellFunction); set onKeyDown(onKeyDown: SohoDataGridKeyDownFunction); set onExpandRow(onExpandRow: SohoDataGridExpandRowFunction); set fallbackImage(fallbackImage: string | undefined); get fallbackImage(): string | undefined; set fallbackTooltip(fallbackTooltip: SohoFallbackTooltipOptions | undefined); get fallbackTooltip(): SohoFallbackTooltipOptions | undefined; /** * Event fired after edit mode is activated on an editor. * * @param args the event arguments */ private onExitEditMode; /** * Event fired before edit mode is activated on an editor. * * @param args the event arguments */ private onBeforeEnterEditMode; /** * Event fired when edit mode is activated on an editor. * * @param args the event arguments */ private onEnterEditMode; /** * Event fired after a child row has been collapsed. */ private onCollapseRow; /** * Event fired when a row has been added. */ private onRowAdd; /** * Event fired when a cell has changed. */ private onCellChange; /** * Event fired when a row has been clicked. */ private onRowClicked; /** * Event fired when the filter row is closed. */ private onCloseFilterRow; /** * Event fired when a context menu is is clicked. */ private onContextMenu; /** * Event fired when a context menu is is clicked. */ private onDoubleClick; /** * Event fired when the data is filtered. */ private onFiltered; /** * Event fired when filter row opened. */ private onOpenFilterRow; /** * Event fired when a row is removed. */ private onRowRemove; /** * Event fired when the data is rendered */ private onRendered; /** * Event fired when the data is filtered. */ private onAfterRender; /** * Event fired before a row is activated. */ private onBeforeRowActivated; /** * Event fired when a row is activated. */ private onRowActivated; private onColumnChange; /** * Event fired when a row is deactivated. */ private onRowDeactivated; /** * Event fired when a row is reordered. */ private onRowReordered; /** * Event fired when a row is selected or deselected. */ private onSelected; /** * Event fired when rows are deselected. */ private onDeselected; /** * Event fired when settings are changed on the grid. */ private onSettingsChanged; /** * Event fired when the data is sorted. */ private onSorted; /** * Event fired when search in toolbar is triggered * @param args Searched data */ private onSearched; /** * Event fired when using built-in pager to next page. */ private onNextPage; /** * Event fired when using built-in pager to previous page. */ private onPreviousPage; /** * Event fired when using built-in pager to first page. */ private onFirstPage; /** * Event fired when using built-in pager to last page. */ private onLastPage; /** * Event fired on paging size change */ private onPageSizeChange; /** * Event fired before paging */ private onBeforePaging; /** * Event fired after paging */ private onAfterPaging; /** * Event fired after vertical scroll */ private onVerticalScroll; /** * Event fired after vertical scroll */ private onFilterOperatorChanged; /** * Returns the row dom jQuery node. * * @param row The row index. * @param includeGroups If true groups are taken into account. * @return The dom jQuery node */ rowNode(row: number, includeGroups: boolean): any; /** * Returns the cell dom node. * * @param row The row index. * @param cell The cell index. * @param includeGroups If true groups are taken into account. * @return The dom node */ cellNode(row: number, cell: number, includeGroups: boolean): any; /** * Expand Detail Row Or Tree Row * @param {number} dataRowIndex The row to toggle * @param {boolean} expandOnly Set the toggle to expand only */ toggleRowDetail(dataRowIndex: number, expandOnly?: boolean | undefined): void; updateSummaryRow(col: object, cell: number): void; /** * Initialize the component after Angular initializes the data-bound input properties. */ ngOnInit(): void; /** * Called after Angular projects external content into its view. */ ngAfterViewInit(): void; /** * */ ngAfterViewChecked(): void; /** * Cleanup just before Angular destroys the component. * * Unsubscribe observables, detach event handlers and remove other resources to avoid memory leaks. */ ngOnDestroy(): void; /** * Destroys the jQuery control (and any other resources) * associated with this component. */ private destroyDataGrid; /** * Handles the 'postCellRender' event. * * @param container the container to host the element. * @param args the formatter arguments. */ private onPostRenderCellHandler; /** * Handles the 'destroyCell' event. * * @param container the container. * @param args the args */ private onDestroyCellHandler; private onEditCellHandler; private buildDataGrid; /** * Marks the components as requiring a rebuild after the next update. * * @todo possible add hints? Rebuild, Update, SetOption * * @param optionName - the option that was updated, (allowing specific handling) * @param hint - the type of refresh required, update?. */ private markForRefresh; /** * Stop gap method to update the current datagrid and rebuild it again. * * This is required whilst there is no method found that can update the view * for a particular input. */ updated(settings?: SohoDataGridOptions): void; /** * Update the dataset of datagrid * @param dataset New dataset to be used * @param pagerInfo Pager info if needed */ updateDataset(dataset: Array, pagerInfo?: object | undefined): void; /** * Updates the source setting/function to use source input if set. * Otherwise use dataGridService if that is set. * * @param source the function */ private updateSource; private checkForComponentEditors; private checkForSummaryRowSettings; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Details of the 'expandrow' and 'collapserow' events. */ interface SohoDataGridToggleRowEvent extends SohoDataGridRowExpandEvent { grid: SohoDataGridComponent; args?: any; } /** * Details of the 'keydown' event */ interface SohoDataGridKeyDownEvent { e: JQuery.Event; args?: SohoDataGridKeyDownArgs; response?: Function; } declare class SohoDataGridModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoDatePickerComponent extends BaseControlValueAccessor implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; ref: ChangeDetectorRef; /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; /** * Local variables */ private jQueryElement?; private datepicker?; private isDisabled?; private isReadOnly?; private _options; private updateLegend; private _validation; /** * Indicates to display the timepicker; defaults to false. */ set showTime(showTime: boolean); /** * If true current time will be used for the time portion otherwise 12:00 midnight is used. */ set useCurrentTime(useCurrentTime: boolean); /** * Indicates the pattern for the time format. */ set timeFormat(timeFormat: string); /** * An integer from 1 to 60; multiples of this value are displayed as options in the minutes dropdown. */ set minuteInterval(minuteInterval: number); /** * An integer from 1 to 60; multiples of this value are displayed as options in the seconds dropdown. */ set secondInterval(secondInterval: number); /** * Change the datepickers first day of the week. * An integer from 0 - 6 where 0 = Sunday, 1 = Monday, etc... */ set firstDayOfWeek(firstDayOfWeek: SohoDatePickerDayOfWeek); /** * If true the field will be sized to the width of the date. */ set autoSize(autoSize: boolean); /** * Show the today button on the header. */ set showToday(showToday: boolean); /** Add extra attributes like id's to the component **/ set attributes(attributes: Array | Object); /** * Indicates mode, either 'standard' or 'range'. */ set mode(mode: SohoDatePickerMode); /** * Use range of two dates options. */ set range(range: SohoDatePickerRange); /** * If a non-matching minutes value is entered, will round the minutes value to the nearest interval on the blur event. */ set roundToInterval(roundToInterval: boolean); /** * Indicates the pattern for the date format or the value of 'locale'. */ set dateFormat(dateFormat: string); /** * Indicates a placeholder for an empty value; defaults to false. */ set placeholder(placeholder: string); /** * Indicates an object containing a date or range of dates that are enabled or disabled. */ set disable(disable: any); /** * Indicates a legend is shown to associate dates */ set showLegend(showLegend: boolean); /** * Indicates if the month and year will render as dropdowns. */ set showMonthYearPicker(showMonthYearPicker: boolean); /** * Indicates if the month and year will render as dropdowns. */ set showWeekNumber(showWeekNumber: boolean); /** * Indicates if the days portion of the calendar will be hidden. */ set hideDays(hideDays: boolean); /** * The number of years ahead to show in the month/year picker should total 9 with yearsBack. */ set yearsAhead(yearsAhead: number); /** * The number of years back to show in the month/year picker should total 9 with yearsAhead. */ set yearsBack(yearsBack: number); /** * Options for how the legend displays */ set legend(legend: Array); /** * The name of the locale to use for this instance. If not set, the current locale will be used. */ set locale(locale: string); /** * Calendar's name. Currently just 'gregorian' or 'islamic-umalqura' */ set calendarName(calendarName: SohoDatePickerCalendarName); /** * Indicates if the dates will use UTC format */ set useUTC(useUTC: boolean); /** * Set the input to tabbable */ set tabbable(tabbable: boolean); /** * Set the input to allow increment/decrement using keyboard */ set incrementWithKeyboard(incrementWithKeyboard: boolean); /** * Set the input to allow today using keyboard */ set todayWithKeyboard(todayWithKeyboard: boolean); /** * If false, the user cannot type into the datepicker field and must * select a date exclusively from the calendar popup. Defaults to true. */ set editable(editable: boolean); get editable(): boolean | undefined; /** * Sets the options for the date picker */ set options(options: SohoDatePickerOptions); set validation(validation: SohoDatePickerValidator); get options(): SohoDatePickerOptions; /** * Enables or disables the control */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * Sets the control to readonly */ set readonly(value: boolean | undefined); get readonly(): boolean | undefined; /** * Called when the datepicker value changes * * @todo replace override of native attribute */ change: EventEmitter; /** * Called when the datepicker is closed. */ listclosed: EventEmitter; /** * Called when the datepicker is opened. */ listopened: EventEmitter; /** * Called before a month will be rendered in the datepicker */ beforemonthrendered: EventEmitter; /** * Called after a month has been rendered in the datepicker */ monthrendered: EventEmitter; /** * Public API */ setValue(value: string | Date | number | string[], trigger: boolean, isTime: boolean): void; getValue(asDate?: boolean): string | Date | number | string[]; focus(): void; openCalendar(): void; /** * Bind attributes to the host input element */ get isDatepicker(): boolean; get isTimepicker(): boolean; /** * Creates an instance of SohoDatePickerComponent. * * @param element the element this component encapsulates. * @param ngZone the angular zone for this component. * @param ref reference to the change detector */ constructor(element: ElementRef, ngZone: NgZone, ref: ChangeDetectorRef); ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Handle the control being changed. */ onChange(event: SohoDatePickerEvent): void; /** * Override writeValue to allow the date picker * element to be updated correctly. * * @param value - the new value */ writeValue(value: Date | string | number | string[]): void; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(isDisabled: boolean): void; ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; private onListClosed; private onListOpened; private onBeforeMonthRendered; private onMonthRendered; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoDatePickerModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoDragDirective implements AfterViewInit, OnDestroy { private elementRef; private ngZone; set dragOptions(dragOptions: SohoDragOptions); dragStart: EventEmitter; dragEnd: EventEmitter; dragging: EventEmitter; private jQueryElement?; private _dragOptions?; private drag?; constructor(elementRef: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; getElementsFromPoint(x: number, y: number): Element[]; ngOnDestroy(): void; updated(settings?: SohoDragOptions): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoDragModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular wrapper for the `dropdown` widget in the ids-enterprise controls. */ declare class SohoDropDownComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; ngControl: NgControl; ref: ChangeDetectorRef; /** * Used to provide unnamed controls with a unique id. */ private static counter; /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; /** * Integration with the Angular ControlValueAccessor for form controls. */ private valueAccessor?; /** * Selector for originating element. */ private jQueryElement?; /** * Reference to the IDS Enterprise Api. */ private dropdown?; /** * Default block of options, use the accessors to modify. */ private options; private isReadOnly?; /** * Sets the dropdown to close on selecting a value (helpful for multi-select) */ set closeOnSelect(closeOnSelect: boolean | undefined); get closeOnSelect(): boolean | undefined; /** * Append a css class to the dropdown-list */ set cssClass(cssClass: string | undefined); get cssClass(): string | undefined; /** * Typing debounce for search */ set delay(delay: number | undefined); get delay(): number | undefined; /** * Sets the icon used as the Dropdown Indicator */ set dropdownIcon(icon: string | undefined); get dropdownIcon(): string | undefined; /** * Initialize the empty value */ set empty(empty: boolean | undefined); get empty(): boolean | undefined; /** Set `no-margin` class to lookup wrapper */ set noMarginWrapper(noMarginWrapper: boolean | undefined); get noMarginWrapper(): boolean | undefined; /** * Value of the maximum number of selected elements (must have multiple set to true) */ set maxSelected(maxSelected: number | undefined); get maxSelected(): number | undefined; /** * Flag to move the selected values to the top of the dropdown * * @deprecated use moveSelected */ set moveSelectedToTop(moveSelectedToTop: boolean | undefined); get moveSelectedToTop(): boolean | undefined; set moveSelected(moveSelected: SohoDropDownMoveSelectedOptions | undefined); get moveSelected(): SohoDropDownMoveSelectedOptions | undefined; set showEmptyGroupHeaders(showEmptyGroupHeaders: boolean | undefined); get showEmptyGroupHeaders(): boolean | undefined; set sourceArguments(sourceArguments: any); get sourceArguments(): any; /** * Determines the frequency of reloading data from an external source */ set reload(reload: SohoDropDownReloadStyles); get reload(): SohoDropDownReloadStyles; /** * If set the width of the dropdown is limited to this pixel width. * Use 300 for the 300 px size fields. Default is size of the largest data. */ set maxWidth(maxWidth: number | undefined); get maxWidth(): number | undefined; /** * Sets the exact width of the open list, by default its the size of the field */ set width(width: number | undefined); get width(): number | undefined; set filterMode(filterMode: SohoDropDownFilterModeOptions | undefined); get filterMode(): SohoDropDownFilterModeOptions | undefined; set virtualScroll(virtualScroll: boolean | undefined); get virtualScroll(): boolean | undefined; /** * Sets the select element as a multi-select */ set multiple(multiple: boolean | undefined); get multiple(): boolean | undefined; /** * Name for the dropdown control. Necessary for ngModel to function. */ name: string; /** * Flag to add/remove search functionality from the dropdown */ set noSearch(noSearch: boolean | undefined); get noSearch(): boolean | undefined; /** * Existent as a helper... should use framework's API to get data and * then create and pass to the control to use */ set source(source: SohoDropDownSourceFunction | Object | string | undefined); get source(): SohoDropDownSourceFunction | Object | string | undefined; /** * Initialize the showSelectAll value for multi-select drop downs */ set showSelectAll(selectAll: boolean | undefined); get showSelectAll(): boolean | undefined; /** * Initialize the showTags value for multi-select drop downs */ set showTags(showTags: boolean | undefined); get showTags(): boolean | undefined; /** * If true, moves the Searchfield in the Dropdown list from directly on top of the pseudo-lement * to underneath/above, providing visibility into the currently selected results. */ set showSearchUnderSelected(showSearchUnderSelected: boolean | undefined); get showSearchUnderSelected(): boolean | undefined; /** * If defined, passes along 'clickHandler' and 'dismissHandler' functions to any Tags */ set tagSettings(tagSettings: any); get tagSettings(): any; /** * If defined, passes along 'clickHandler' and 'dismissHandler' functions to any Tags */ set allTextString(allTextString: string | undefined); get allTextString(): string | undefined; /** * @param appendTo additional classes */ set appendTo(appendTo: string); /**Custom text string for `Selected` text header use in MultiSelect */ set selectedTextString(selectedTextString: string); get selectedTextString(): string; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** * Called when the dropdown value changes * * @todo replace override of native attribute */ change$: EventEmitter>; /** * Called when the dropdown updates in some way. */ updated$: EventEmitter>; /** * Fired when the dropdown list is closed. */ listClosed$: EventEmitter; /** * Fired when the dropdown list is opened. */ listOpened$: EventEmitter; /** * Fired when the dropdown list is right clicked. */ listContextMenu$: EventEmitter; /** * This event is fired when a key is pressed */ keydown$: EventEmitter; /** * Bind attributes to the host select element */ /** * Assign the id for the control * (maps to the name to use on a label's 'for' attribute) */ get id(): any; get isMultiple(): boolean | undefined; get isDropdown(): boolean; get isMultiSelect(): any; set readonly(readonly: boolean | undefined); get readonly(): boolean | undefined; /** * Creates an instance of SohoDropDownComponent. * * @param element the element this component encapsulates. * @param ngZone the angular zone for this component * @param ngControl any associated form control (optional) * @param ref the change detector reference, must not be null. */ constructor(element: ElementRef, ngZone: NgZone, ngControl: NgControl, ref: ChangeDetectorRef); ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; /** * Event handler for the 'requestend' event on the dropdown 'component'. * * * @param event the standard jQuery event. * @param data any data passed by the dropdown (todo the type) * */ private onRequestEnd; private onUpdated; /** * Event handler for the 'changed' event on the 'dropdown' component. * @param event the standard jQuery event. */ private onChanged; /** * Event handler for the 'listchanged' event on the 'dropdown' component. * @param event the standard jQuery event. */ private onListContextMenu; /** * Handles the 'listopened' event triggered by the underlying jQuery control. * * @param event the fired event. */ private onListOpened; /** * Handles the 'listclosed' event triggered by the underlying jQuery control. * * @param event the fired event. */ private onListClosed; /** * In case options are being bound asynchronously, you will need to trigger updated on * soho dropdown control so it updates its value labels. */ updated(): SohoDropDownComponent; set disabled(value: boolean); /** * @description * * Soho-dropdown is not a native element - need this to set focus programmatically. */ setFocus(): void; /** * @description * * Sets the value of the dropdown. * * @todo this may need to involve mapping from actual value * if ngModel is used. * * This is the model value that is to be set. * @param value - the internal value to select */ selectValue(value: any): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; /** * Adds an inline error message to the dropdown * * @param message the error message to add. */ addInlineError(message: string): void; /** * Adds an inline message of the type specified * * @param message the message to add. * @param type optional - 'error' (default) * @param isAlert optional - false (default) * @param triggerEvents optional - true (default) * @param icon optional - icon for the message * @param id optional - id for the message */ addInlineMessage(message: string, type?: SohoAlertType, isAlert?: boolean, triggerEvents?: boolean, icon?: string, id?: string): void; /** * Removes inline message of the specified type * * @param type the message type to remove ('error', 'alert', etc.) * @param triggerEvents optional - true (default) */ removeMessage(type?: SohoAlertType, triggerEvents?: boolean): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoDropDownModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoEditorComponent extends BaseControlValueAccessor implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; private ref; private options; /** * Local variables */ /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; private isDisabled?; private isReadOnly?; get isEditor(): boolean; /** * Enables or disables the control */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * Sets the control to readonly */ set readonly(value: boolean | undefined); get readonly(): boolean | undefined; set delay(delay: number); set firstHeader(firstHeader: string); set secondHeader(secondHeader: string); set placeholder(placeholder: string); set anchor(anchor: SohoEditorAnchor); set image(image: SohoEditorOptionsImage); set buttons(buttons: SohoEditorButtons); set excludeButtons(buttons: SohoEditorButtons); /** * onLinkClick Callback for Editor clicks */ set onLinkClick(value: (e: JQuery.TriggeredEvent, elem: any) => void); set showHtmlView(showHtmlView: boolean); set preview(preview: boolean); set rows(rows: SohoEditorRows); set attributes(attributes: Array | Object); /** * Called when the editor value changes * * @todo replace override of native attribute */ change: EventEmitter; /** * Called when the editor updates in some way */ updated: EventEmitter; generateai: EventEmitter; private jQueryElement?; private editor?; /** * Creates an instance of SohoEditorComponent. * * @param element the element this component encapsulates. * @param ngZone the angualar zone for this component. * @param ref reference to the change detector */ constructor(element: ElementRef, ngZone: NgZone, ref: ChangeDetectorRef); ngAfterViewInit(): void; ngAfterViewChecked(): void; /** * Handle the control being changed. */ onChange(_event: SohoEditorEvent): void; /** * Handle the generate AI button being clicked */ onGenerateAi(event: SohoEditorEvent): void; /** * Handle the updated event firing */ onUpdated(event: SohoEditorEvent): void; /** * * @param value Handle model updates. */ writeValue(value: any): void; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(isDisabled: boolean): void; ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoEditorModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the SohoEmptyMessage Control. */ declare class SohoEmptyMessageDirective implements AfterViewChecked, AfterViewInit { private changeDetector; private element; /** * The `emptyMessage` option. */ set emptyMessageOptions(options: SohoEmptyMessageOptions); get emptyMessageOptions(): SohoEmptyMessageOptions; set title(title: string | undefined); get title(): string | undefined; set info(info: string | undefined); get info(): string | undefined; set icon(icon: string | undefined); get icon(): string | undefined; set height(height: string | undefined); get height(): string | undefined; set button(button: SohoEmptyMessageButtonOptions | undefined); get button(): SohoEmptyMessageButtonOptions | undefined; set color(color: EmptyMessageColor | undefined); get color(): EmptyMessageColor | undefined; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; private _emptyMessageOptions; private jQueryElement?; private emptymessage?; private updateComponent; constructor(changeDetector: ChangeDetectorRef, element: ElementRef); /** * After the control has been initialised and the view is ready, * construct the empty message sohoxi component. */ ngAfterViewInit(): void; /** * */ ngAfterViewChecked(): void; /** * Marks the components as requiring a rebuild after the next update. */ private markForCheck; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoEmptyMessageModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the SoHo Error Directive. * * @deprecated - use SohoAlert instead */ declare class SohoErrorDirective implements AfterViewInit { private el; private _options; private jQueryElement?; constructor(el: ElementRef); /** * message for the error. * * @deprecated - use SohoAlert instead */ set message(message: string); /** * set error in tooltip. * * @deprecated - use SohoAlert instead */ set showTooltip(showTooltip: boolean); /** * set error to be inline. * * @deprecated - use SohoAlert instead */ set inline(inline: boolean); /** * Returns the data object data-errormessage * * @deprecated - use SohoAlert instead */ get errorMessage(): JQuery | undefined; /** * add inline error * * @deprecated - use SohoAlert instead */ addInlineError(message: string): void; /** * add tooltip error * * @deprecated - use SohoAlert instead */ addTooltipError(message: string): void; /** * remove inline/tooltip error * * @deprecated - use SohoAlert instead */ removeError(): void; /** * Scrolls the element into the visible area of the browser window * * @deprecated - use SohoAlert instead * @param alignToTop (boolean) optional - true (default) element will be aligned to the top of the visible area of the scrollable ancestor */ scrollIntoView(alignToTop?: boolean): void; /** * After the control has been initialised and the view is ready, * get the SoHoXi controls to activate any validations. */ ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoErrorModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Helper Component for the ExpandableAreaComponent */ declare class ExpandableHeaderComponent { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Helper Component for the ExpandableAreaComponent */ declare class ExpandablePaneComponent { fixed: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Helper Component for the ExpandableAreaComponent */ declare class ExpandableFooterComponent { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class ExpandableAreaComponent implements AfterViewInit, OnDestroy { private element; private changeDetectorRef; private ngZone; id: string | undefined; trigger?: string; set disabled(value: boolean | undefined); /** * Boolean value of the disabled state of the component */ get disabled(): boolean | undefined; set closed(value: boolean | undefined); /** * Boolean value of the closed state of the component */ get closed(): boolean | undefined; toggle?: Observable; header: ExpandableHeaderComponent | undefined; panes: QueryList | undefined; footer?: ExpandablePaneComponent; beforeexpand: EventEmitter; beforecollapse: EventEmitter; expand: EventEmitter; collapse: EventEmitter; afterexpand: EventEmitter; aftercollapse: EventEmitter; private jQueryElement?; private expandablearea?; private _disabled?; private _closed?; hasFixedPane: boolean; constructor(element: ElementRef, changeDetectorRef: ChangeDetectorRef, ngZone: NgZone); ngAfterViewInit(): void; ngOnDestroy(): void; /** * Calls the expandablearea disable function */ disable(): void; /** * Calls the expandablearea enable function */ enable(): void; /** * Toggles the state of the expandablearea (open or closed) based on the passed * parameter. */ toggleOpen(open: boolean): void; close(): void; open(): void; /** * The class setter for the expandable area div element */ get expandableAreaClasses(): string; /** * The class setter for the header element */ get headerClasses(): string; /** * The class setter for the pane element */ get paneClasses(): string; /** * The class setter for the pane element */ get footerClasses(): string; /** * The class setter for the visible pane element */ get visiblePaneClasses(): string; private onBeforeExpand; private onBeforeCollapse; private onExpand; private onCollapse; private onAfterExpand; private onAfterCollapse; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoExpandableAreaModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFieldFilterDirective implements AfterViewChecked, AfterViewInit, OnDestroy { private ref; private element; private ngZone; set fieldSettings(settings: SohoFieldFilterSettings); set fieldDropdownDataSet(dataset: Array); set dropdownOpts(options: SohoDropDownOptions); set template(template: string); set selectedFilterType(type: SohoFieldFilterOperator); filtered: EventEmitter; private _settings; /** * Local variables */ private jQueryElement?; private fieldFilter?; private runUpdatedOnCheck?; constructor(ref: ChangeDetectorRef, element: ElementRef, ngZone: NgZone); ngAfterViewChecked(): void; ngAfterViewInit(): void; /** * Get current filter type * returns {object} The current filter type */ getFilterType(): any; /** * Set filter type to given value * param {number|string} value to be set, index or value. * returns {void} */ setFilterType(value: SohoFieldFilterOperator | number | string): void; /** Destructor. */ ngOnDestroy(): void; markForRefresh(): void; private onFiltered; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoFieldFilterModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFieldOptionsDirective implements AfterViewInit, OnDestroy { private element; private ngZone; private _options; allFieldOptions: boolean; /** * Local variables */ private jQueryElement?; private fieldOptions?; constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; /** Destructor. */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoFieldOptionsModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } interface SohoRevealTextSettings { initialState?: 'show' | 'hide'; revealCharacters?: number; maskingType?: 'digit' | 'email' | 'phone' | 'address' | 'birthday' | string; revealBtn?: 'icon' | 'text' | string; revealPosition?: 'start' | 'end' | string; } declare class SohoRevealableTextMaskDirective implements AfterViewInit, OnDestroy { private element; private ngZone; set revealTextSettings(settings: SohoRevealTextSettings); private _settings; private jQueryElement?; constructor(element: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; private initRevealText; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoFieldSetModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFileUploadComponent implements AfterViewInit, OnDestroy { private element; private changeDetectorRef; private ngZone; get isFileUpload(): boolean; get isFileUploadType(): string; /** * Local variables */ isDisabled?: boolean; isReadOnly?: boolean; set disabled(value: boolean | undefined); get disabled(): boolean | undefined; set readonly(value: boolean | undefined); get readonly(): boolean | undefined; /** * Called when the fileupload value changes * * @todo replace override of native attribute */ change: EventEmitter; private jQueryElement?; private fileUpload?; private options; constructor(element: ElementRef, changeDetectorRef: ChangeDetectorRef, ngZone: NgZone); /** Called when the value changes. */ changeEvent: EventEmitter; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; set tabbable(value: boolean | undefined); get tabbable(): boolean | undefined; ngAfterViewInit(): void; ngOnDestroy(): void; clearUploadFile(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoFileUploadModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFileUploadAdvancedComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ref; private ngZone; /** * Add class to host element to ensure correct styling and detection by EP controls. */ isFileUploadAdvanced: boolean; /** * Local variables */ /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; /** Keeps track of the enabled / disabled state. */ isDisabled?: boolean; /** * Set the disabled state of the control. */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * Show or hide the progress bar. * * @param progressBar - If true, shows the progress bar; otherwise hides it. */ set progressBar(value: boolean | undefined); get progressBar(): boolean | undefined; /** * On page(true) -or- on modal (false) , this is used for some visual style only. * * @param isStandalone true for onPage otherwise false. */ set isStandalone(isStandaline: boolean | undefined); get isStandalone(): boolean | undefined; /** * Restrict file types(ie. 'jpg|png|gif') ['*' all types] * * @param allowedTypes - the allowed types. */ set allowedTypes(allowedTypes: string | undefined); get allowedTypes(): string | undefined; /** * Defines the send method used to upload the files. * * The send function takes the FormData containing the file, and a * status interface to provide fedback to the control whilst uploading. * * @param sendFn - the callback function responsible to uploading the file. */ set send(sendFn: SohoFileUploadAdvancedSendFunction | any); get send(): any; /** * Restricts the number of files that can be retrieved in total. * * @param maxFiles - max files cab be upload. */ set maxFiles(maxFiles: number | undefined); get maxFiles(): number | undefined; /** * Restricts the number of files that can be retrieved while in process. * * @param maxFilesInProcess - the callback function responsible to uploading the file. */ set maxFilesInProcess(maxFilesInProcess: number | undefined); get maxFilesInProcess(): number | undefined; /** * Max file size in bytes, -1 for unlimited. * * @param maxFileSize - Max file size in bytes, -1 for unlimited. */ set maxFileSize(maxFileSize: number | undefined); get maxFileSize(): number | undefined; /** * Variable name to read from server. * * @param fileName - Variable name to read from server.. */ set fileName(fileName: string | undefined); get fileName(): string | undefined; /** * Add way to browse files to upload * * @param showBrowseButton - if true, displays the browse button; otherwise do not. */ set showBrowseButton(showBrowseButton: boolean | undefined); get showBrowseButton(): boolean | undefined; /** * Text to show in drop area. * * @param textDropArea - Text to show in drop area. */ set textDropArea(textDropArea: string | undefined); get textDropArea(): string | undefined; /** * Text to show in drop area when browse option true. * * @param textDropAreaWithBrowse - Text to show in drop area when browse option true. */ set textDropAreaWithBrowse(textDropAreaWithBrowse: string | undefined); get textDropAreaWithBrowse(): string | undefined; /** * Hidden text for cancel button. * * @param textBtnCancel - Hidden text for cancel button. */ set textBtnCancel(textBtnCancel: string | undefined); get textBtnCancel(): string | undefined; /** * Hidden text for error close button * * @param textBtnCloseError - Hidden text for error close button. */ set textBtnCloseError(textBtnCloseError: string | undefined); get textBtnCloseError(): string | undefined; /** * Hidden text for remove button. * * @param textBtnRemove - Hidden text for remove button. */ set textBtnRemove(textBtnRemove: string | undefined); get textBtnRemove(): string | undefined; /** * */ set errorMaxFiles(errorMaxFiles: string | undefined); get errorMaxFiles(): string | undefined; /** * */ set errorMaxFilesInProcess(errorMaxFilesInProcess: string | undefined); get errorMaxFilesInProcess(): string | undefined; /** * */ set errorMaxFileSize(errorMaxFilesSize: string | undefined); get errorMaxFileSize(): string | undefined; /** * Called when the fileupload value changes */ filesdragenter: EventEmitter>; filesdropped: EventEmitter; beforecreatestatus: EventEmitter; aftercreatestatus: EventEmitter; fileprogress: EventEmitter; fileaborted: EventEmitter; filecompleteduploading: EventEmitter; fileremoved: EventEmitter; filefailed: EventEmitter; /** Set of options for this control. */ private options; private jQueryElement?; private fileuploadadvanced?; /** * Updates the control by merging the given settings into * the EP widget. * * @param settings the settings to merge. */ updated(settings: SohoFileUploadAdvancedOptions): void; /** * Destroys the control. */ destroy(): void; /** * Set status of a file in progress to failed */ setFailed(error: string, fileIndex?: number): void; /** * Constructor. */ constructor(element: ElementRef, ref: ChangeDetectorRef, ngZone: NgZone); ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoFileUploadAdvancedModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFormCompactComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private options; get isFormCompact(): boolean; private jQueryElement?; private formcompact?; private updateRequired; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; ngAfterViewChecked(): void; /** Tear Down */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoFormCompactModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoHierarchyLeafTemplateComponent { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoHierarchyComponent implements OnDestroy, AfterViewInit { private elementRef; private ngZone; private hierarchy?; private jQueryElement?; /** An internal options object that gets updated by using the component's Inputs(). */ private options; hostClass: string; set dataset(dataset: Array | undefined); get dataset(): Array | undefined; set legend(legend: Array | undefined); get legend(): Array | undefined; set legendKey(key: string | undefined); get legendKey(): string | undefined; set templateId(id: string | undefined); get leafTemplateId(): string | undefined; set layout(layout: SohoHierarchyLayoutType | undefined); get layout(): SohoHierarchyLayoutType | undefined; /** * Leaf is selected * */ selected: EventEmitter; /** * Leaf is double clicked. */ doubleClick: EventEmitter; constructor(elementRef: ElementRef, ngZone: NgZone); /** * Used to add new data lazily when a leaf is expanded * * @param id should match the leaf id in the DOM */ add(id: string, dataset: Array, newData: Array): void; /** * Reload hierarchy with a new dataset */ reloadDataSet(dataSet: Array): void; /** * Update actions for action menu on a leaf */ updateActions(eventInfo: SohoHierarchyEvent, updatedActions: Array): void; /** * Manually select leaf by id */ selectLeaf(leafId: string): void; ngOnDestroy(): void; ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoHierarchyModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoHeaderComponent implements AfterViewInit, OnDestroy { private elementRef; isHeader: boolean; isPersonalizable: boolean; hasToolbar: any; hasTabs: any; /** * This event is fired when the status of the header is changed. * */ updated: EventEmitter; private jQueryElement?; private header?; constructor(elementRef: ElementRef); /** * Used to manually remove the back button when * Which is used in the header via the list/detail pattern */ removeBackButton(): void; ngAfterViewInit(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoHeaderModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoHomePageComponent implements AfterViewInit, OnDestroy { private elementRef; private ngZone; /** * @todo replace override of native attribute */ resize: EventEmitter; resizecard: EventEmitter; reordercard: EventEmitter; removecard: EventEmitter; set homePageOptions(homePageOptions: SohoHomePageOptions); get homePageOptions(): SohoHomePageOptions; /** * Whether to animate widget placement */ set animate(animate: boolean | undefined); get animate(): boolean | undefined; /** * Sets the maximum number of widget columns */ set columns(columns: number | undefined); get columns(): number | undefined; /** * Set edit for rearranging/reordering cards. */ set editing(editing: boolean | undefined); get editing(): boolean | undefined; /** * Specify the speed at which an animation progresses at different points within the animation. */ set easing(easing: EasingType | undefined); get easing(): EasingType | undefined; /** * Sets gutter size in between widgets */ set gutterSize(gutterSize: number | undefined); get gutterSize(): number | undefined; /** * Sets the default widget width in pixels */ set widgetWidth(widgetWidth: number | undefined); get widgetWidth(): number | undefined; /** * Sets the default widget height in pixels */ set widgetHeight(widgetHeight: number | undefined); get widgetHeight(): number | undefined; /** * Sets the widgets to smaller size */ set useSmall(useSmall: boolean | undefined); get useSmall(): boolean | undefined; /** * this ... */ set timeout(timeout: number | undefined); get timeout(): number | undefined; /** * Event fired before a card is removed * * @param beforeSelectFunction Function callback */ set onBeforeRemoveCard(beforeSelectFunction: SohoHomePageBeforeRemoveCardFunction | undefined); get onBeforeRemoveCard(): SohoHomePageBeforeRemoveCardFunction | undefined; set banner(banner: SohoHomePageBannerOptions | undefined); get banner(): SohoHomePageBannerOptions | undefined; isHomepage: boolean; private jQueryElement?; private homepage?; private _homePageOptions; constructor(elementRef: ElementRef, ngZone: NgZone); /** * Reset columns to their defaults (used on restore menu item). */ refresh(animate?: boolean): void; ngAfterViewInit(): void; onResize(columns: number, metadata: object): void; onResizeCard(card: JQuery, metadata: object): void; onReorderCard(card: JQuery, metadata: object): void; onRemoveCard(card: JQuery, metadata: object): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } type WidgetSize = 'single' | 'double' | 'triple' | 'quad'; declare class SohoWidgetComponent implements AfterViewInit, OnInit { private elementRef; private ngZone; get classList(): string; isWidget: boolean; get isNoHeader(): boolean | undefined; get isNoShadow(): boolean | undefined; widgetWidth?: WidgetSize; widgetHeight?: WidgetSize | 'auto'; removable?: boolean; noHeader: boolean | undefined; noShadow: boolean | undefined; set contentPaddingX(value: number | undefined); set bordered(value: boolean | string | undefined); set contentPaddingY(value: number | undefined); set detailRefId(value: string | undefined); resizecard: EventEmitter; reordercard: EventEmitter; removecard: EventEmitter; private options; private cards?; constructor(elementRef: ElementRef, ngZone: NgZone); private jQueryElement?; ngOnInit(): void; ngAfterViewInit(): void; onResizeCard(card: JQuery, metadata: object): void; onReorderCard(card: JQuery, metadata: object): void; onRemoveCard(card: JQuery, metadata: object): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoWidgetContentComponent { isWidgetContent: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoWidgetHeaderComponent { isWidgetHeader: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoWidgetTitleComponent { tabIndex?: number; isWidgetTitle: boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Angular Directive for keeping a homepage elements height correctly up to date. */ declare class SohoHomepageSizerDirective implements AfterViewInit, OnDestroy { elementRef: ElementRef; private ngZone; get heightStyle(): number | undefined; private jQueryElement?; private containerHeight?; constructor(elementRef: ElementRef, ngZone: NgZone); ngAfterViewInit(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoHomePageModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } type SohoHyperlinkType = 'show-visited' | 'forward-caret' | 'back-caret'; declare class SohoHyperlinkComponent implements AfterViewInit { private element; static SHOWVISITED: SohoHyperlinkType; static DIRECTIONAL: SohoHyperlinkType; static BACK: SohoHyperlinkType; /** * The type of the hyperlink, defaulting to 'hide-focus'. * * @todo replace override of native attribute */ set sohoHyperlink(type: SohoHyperlinkType | "" | undefined); icon?: string; /** * Sets the expandable-expander class to be placed on the button for the * soho-expandablearea to use as it's expand/collapse trigger * */ expandableExpander: boolean; /** * @todo replace override of native attribute */ change?: EventEmitter; hyperLinkClass: boolean; get showVisitedClass(): true | undefined; get directionalClass(): true | undefined; get backClass(): true | undefined; href?: string; disabled?: boolean; isCaretRight?: boolean; isCaretLeft?: boolean; get isExpandableExpander(): boolean; private hyperlinkType?; private jQueryElement?; constructor(element: ElementRef); ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoHyperlinkModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoInputComponent extends BaseControlValueAccessor implements AfterViewInit, OnDestroy { private element; private ngZone; /** * todo: work around until landmark can change code to allow the initial format. * Right now landmark initially formats the value to current locale. */ fireInputEventKludge: boolean; /** * Available Soho Template events as Output (EventEmitters passing the event) * Should match the Soho event names for the component * * @todo replace override of native attribute */ change: EventEmitter; /** * Input controls managed their disabled state via the 'disabled' attribute. * We use null as the default, rather than false, to ensure the attribute is * not displayed. * * */ isDisabled: boolean | undefined; /** * Clearable attribute. Adds a clear icon in input if true. */ clearable: boolean | undefined; /** * Local variables */ private jQueryElement?; /** * Constructor. * * @param element the owning element. * @param changeDetectionRef change detection. */ constructor(element: ElementRef, ngZone: NgZone); onKeyUp(_event: KeyboardEvent): void; ngAfterViewInit(): void; ngOnDestroy(): void; /** * Handle the control being changed. */ onChange(event: any[]): void; /** * Override writeValue to allow the mask input * element to be updated correctly. * * @param value - the new value */ writeValue(value: any): void; /** * This function is called when the control status changes to or from "DISABLED". * Depending on the value, it will enable or disable the appropriate DOM element. */ setDisabledState(isDisabled: boolean | undefined): void; getValue(): string | undefined; setValue(value: string): void; focus(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoInputModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the SoHo Input Validate Directive. * * This component searches for an element with the attribute * 'data-validate' or 'data-validate-on="submit"'. */ declare class SohoInputValidateDirective implements AfterViewInit, OnDestroy { private el; private ngZone; /** * Local variables */ private jQueryElement?; private validator?; dataValidate: string; /** * @todo replace override of native attribute */ error: EventEmitter; alert: EventEmitter; /** * @todo replace override of native attribute */ success: EventEmitter; icon: EventEmitter; info: EventEmitter; valid: EventEmitter; constructor(el: ElementRef, dataValidateAttr: any, // eslint-disable-line ngZone: NgZone); /** * After the control has been initialised and the view is ready, * get the SoHoXi controls to activate any validations. */ ngAfterViewInit(): void; ngOnDestroy(): void; /** * Remove the message from the field if there is one and mark the field valid */ removeMessage(type: any): void; /** * Trigger validation of the field */ validate(event: any): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoInputValidateModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoLabelDirective implements AfterViewInit { private element; /** * Indicate that the label is audible */ audible?: boolean; /** * Indicate that the label is required */ required?: boolean; /** * Indicate that the label is for checkbox or non-checkbox */ forCheckBox?: boolean; /** * Indicate that the label is for radiobutton or non-radiobutton */ forRadioButton?: boolean; /** * Bind attributes to the host label element */ get isLabel(): boolean; get isCheckBoxLabel(): boolean | undefined; get isRadioButtonLabel(): boolean | undefined; get isAudible(): boolean; get isRequired(): boolean; /** * Local variables */ jQueryElement?: JQuery; constructor(element: ElementRef); ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoLabelModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoLineComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** Options. */ private options; get isLine(): boolean; /** Defines the data to use, must be specified for this component. */ set dataset(dataset: Array); set tooltip(value: string); set isArea(value: boolean); set isBubble(value: boolean); set showLegend(value: boolean); set xAxis(value: object); set yAxis(value: object); set hideDots(value: boolean); set axisLabels(value: any); set animate(value: boolean); set redrawOnResize(value: boolean); set dots(value: object); set formatterString(value: string); set emptyMessage(value: SohoEmptyMessageOptions); selected: EventEmitter; unselected: EventEmitter; rendered: EventEmitter; dblclick: EventEmitter; /** * @todo replace override of native attribute */ contextmenu: EventEmitter; private jQueryElement?; private line?; private updateRequired; constructor(element: ElementRef, ngZone: NgZone); /** Setup */ ngAfterViewInit(): void; ngAfterViewChecked(): void; updated(): void; /** Tear Down */ ngOnDestroy(): void; setSelected(selected: SohoLineSelected): void; toggleSelected(selected: SohoLineSelected): void; getSelected(): Object | Object[] | undefined; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoLineModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoSearchFieldWrapperComponent { get isSearchfieldWrapper(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoSearchFieldComponent implements AfterViewInit, OnDestroy, AfterViewChecked { private element; private ngZone; ref: ChangeDetectorRef; ngControl: NgControl; /** Options. */ options: SohoSearchFieldOptions; set allResultsCallback(value: (searchTerm: string) => void); /** Displays a dropdown containing categories that can be used to filter results. */ set categories(value: SohoSearchFieldCategoryType[]); /** If true, creates a multiselectable Categories list. */ set categoryMultiselect(value: boolean); /** Has an X to clear. */ set clearable(value: boolean); set showAllResults(value: boolean); /** Show any available categories that are selected to teh left of the Dropdown field. */ set showCategoryText(value: boolean); /** Extra button available to show. */ set button(value: SohoSearchFieldExtraButton); /** AutoComplete : Source Function/Data/Url/Array */ set source(value: SohoAutoCompleteSource); /** Template that can be passed */ set template(value: string); /** Number representing a size that will be used when a collapsible Searchfield becomes collapsed. */ set collapseSize(value: ((api: SohoSearchFieldStatic) => number) | number); /** Set the input to tabbable */ set tabbable(value: boolean); selected: EventEmitter; cleared: EventEmitter; get isSearchField(): boolean; /** * Local variables */ private jQueryElement?; private searchfield?; /** * Integration with the Angular ControlValueAccessor for form controls. */ private valueAccessor?; runUpdatedOnCheck: boolean; constructor(element: ElementRef, ngZone: NgZone, ref: ChangeDetectorRef, ngControl: NgControl); ngAfterViewChecked(): void; ngAfterViewInit(): void; ngOnDestroy(): void; clear(): void; /** Gets a complete list of categories in jQuery-collection form. */ getCategories(): any; /** Gets the categories as data. Passing true will return only the selected category data.*/ getCategoryData(onlySelected: boolean): SohoSearchFieldCategory[] | undefined; /** Gets a complete list of categories in jQuery-collection form. */ getSelectedCategories(): any; /** Gets the currently selected list of categories in jQuery-collection form. */ setCategoryButtonText(textContent?: string): void; updated(settings?: SohoSearchFieldOptions): void; checkContents(): void; /** Expand the searchfield (for collapsible searchfields) */ expand(): void; /** Collapse the searchfield (for collapsible searchfields) */ collapse(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * This component will allow the developer to modify any DOM element * by exposing it (if desired) */ declare class SohoListViewSearchComponent { /** * Use this flag if you are projecting a soho-searchfield into this component * from another component and do not want this component to build another * searchfield */ buildSearch: boolean; get isListviewSearch(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewItemComponent implements AfterViewInit { element: ElementRef; /** Underling jQuery item. */ private listItem?; /** Sets the item as disabled. */ disabled: boolean; /** Sets the item as selected. */ selected: boolean; /** * Constructor. * * @param element - the element. */ constructor(element: ElementRef); /** * The index of the list view item in it's parent. */ get index(): number | undefined; get selector(): JQuery | undefined; ngAfterViewInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewHeaderComponent { get isHeading(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewSubHeaderComponent { get isSubHeading(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewMicroComponent { get isMicro(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewComponent implements AfterViewInit, OnDestroy, AfterViewChecked { private ngZone; items?: QueryList; /** * String of classes to append to the class for the list-view div element */ class?: string; sohoListviewElementId?: string; /** * Force a update to fire next viewChecked. */ updateRequired?: boolean; /** * Array of data */ set dataset(value: Object[] | undefined); get dateset(): Object[] | undefined; /** Audible Label (or use parent title). */ set description(value: string); /** If paging is activated, sets the number of listview items available per page. */ set pagesize(value: number); /** If true, activates paging. */ set paging(value: boolean); /** If true, associates itself with a Searchfield/Autocomplete and allows itself to be filtered. */ set searchable(value: boolean | undefined); get searchable(): boolean | undefined; /** false, 'single', or 'multiple'. */ set selectable(value: SohoListViewSelectable); /** Select on focus change?true or false. */ set selectOnFocus(value: boolean); /** External function that can be used to provide an empty message when no data is available. */ set emptyMessage(value: SohoEmptyMessageOptions); /** External function that can be used to provide a datasource, or a URL. */ set source(value: SohoListViewSourceFunction | string); /** Html Template String. */ set template(value: string); set disableItemDeactivation(value: boolean | undefined); get disableItemDeactivation(): boolean | undefined; set allowDeselect(value: boolean | undefined); get allowDeselect(): boolean | undefined; set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** Reveal text settings for masking/revealing text content */ set revealTextSettings(value: SohoListViewRevealableTextData | undefined); get revealTextSettings(): SohoListViewRevealableTextData | undefined; /** * Set the list of selected items either by their indices or via the * jQuery selector for the li element. * * @param selectedItems the list of selected items. * @throws Error if any of the indicies are out of bounds. */ set selectedItems(selectedItems: SohoListViewItemReference[]); /** * Selected List Items. * * Note currenty this returns the index of the selected item. * * @return the indexes of the selected list items. */ get getSelectedItems(): SohoListViewItemReference[] | undefined; /** * Called after the listview is rendered, passes the dataset */ rendered: EventEmitter; /** * Called before an item is selected. Return false to prevent selection. */ beforeSelectCallback?: (event: any, args: any[]) => boolean | void; /** * Called before an item is deselected. Return false to prevent deselection. */ beforeDeselectCallback?: (event: any, args: any[]) => boolean | void; /** * Called before an item is selected. Returns an object containing the event and the * current selected items. */ beforeselect: EventEmitter; /** * Called before an item is deselected. Returns an object containing the event and the * current selected items. */ beforedeselect: EventEmitter; /** * Called once an item is selected. Returns an object containing the event and the * current selected items. */ selected: EventEmitter; /** * Called once an item is deselected. Returns an object containing the event and the * current selected items. */ unselected: EventEmitter; /** * Called once an item is deselected. Returns an object containing the event and the * current selected items. */ deselected: EventEmitter; /** * Called once an item is activated. Returns an object containing the event * and additional info about the activated item. */ itemactivated: EventEmitter; /** * Called once an item is deactivated. Returns an object containing the event * and additional info about the deactivated item. */ itemdeactivated: EventEmitter; /** * Called once an item is clicked. You may also prefer need activated / deactived here. */ click: EventEmitter; /** * Called once an item is double clicked. This isnt used that often. */ dblclick: EventEmitter; /** * Called during right click to enable context menus on list items. * Use popupmenu during this event. */ contextmenu: EventEmitter; /** * Called after the list has been sorted for any reason */ sorted: EventEmitter; listViewRef: ElementRef | undefined; searchfieldRef?: SohoSearchFieldComponent; /** * Local variables */ private jQueryElement?; private listview?; private options; /** * Constructor. */ constructor(ngZone: NgZone); ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; get listClass(): string; /** * Clear all the currently selected listview items that are selected. */ clearAllSelected(): void; /** * Toggle the selected listview items between all and none. */ toggleAll(): void; /** * Removes the list item (or list items) identified by their index or jQuery element. * * @param index - the index (or list of indices) of the items to be removed. * @throws Error if the argument is null, or contains out of range indices then any error is thrown. */ remove(index: SohoListViewItemReference | SohoListViewItemReference[]): void; /** * Unselects the list item (or list items) identified by their index or jQuery element. * * @param index - the index (or list of indices) of the items to be unselected. * @throws Error if the argument is null, or contains out of range indices then any error is thrown. */ unselect(index: SohoListViewItemReference | SohoListViewItemReference[]): void; /** * Selects the list item (or list items) identified by their index or jQuery element. * * If the argument is null, or contains out of range indices then any error is thrown. * * @param index the index (or list of indices) of the items to be deselected. * @throws Error if the argument is null, or contains out of range indices then any error is thrown. */ select(index: SohoListViewItemReference | SohoListViewItemReference[]): void; /** * Activate the given list item. */ activateItem(item: SohoListViewItemReference): void; /** * Return an object containing info about the currently activated item. */ activatedItem(): any; /** * De-activate the given list item. If no item is specified the currently * activated item will be deactivated. */ deactivateItem(item?: SohoListViewItemReference): void; /** * Toggle Activation on the given list item. */ toggleItemActivation(item: SohoListViewItemReference): void; /** * Apply the given function to the list view item(s). * * @param fn the function to apply - must take a SohoListViewReference. * @param index the index of list view item(s). */ private apply; /** * Verifies the given item reference is within allowable ranges. */ private boundsCheck; /** * The number of items in the list. */ private get itemCount(); static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListViewModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoListBuilderComponent implements AfterViewInit, OnDestroy, AfterViewChecked { private ngZone; get isListbuilder(): boolean; /** * Local variables */ private jQueryElement?; private listbuilder?; private options; /** * Force a update to fire next viewChecked. */ updateRequired?: boolean; /** * Constructor. */ constructor(ngZone: NgZone); listBuilderRef: ElementRef | undefined; sohoListBuilderElementId?: string; /** * String of classes to append to the class for the list-view div element */ class?: string; get listClass(): string; /** * Array of data */ set dataset(value: Object[] | undefined); get dataset(): Object[] | undefined; /** The CSS Class of the handle element */ set handle(value: string); /** "Add" action button (takes a string representing a "data-action" attribute */ set btnAdd(value: string); /** "Edit" action button (takes a string representing a "data-action" attribute */ set btnEdit(value: string); /** "Delete" action button (takes a string representing a "data-action" attribute */ set btnDelete(value: string); /** "GoUp" action button (takes a string representing a "data-action" attribute */ set btnGoUp(value: string); /** "GoDown" action button (takes a string representing a "data-action" attribute */ set btnGoDown(value: string); /** Add extra attributes like id's to the chart elements. For example `attributes: { name: 'id', value: 'my-unique-id' } */ set attributes(attributes: Array | Object | undefined); /** Html Template String of list. */ set template(value: string); /** Html Template String of list item. */ set templateNewItem(value: string); /** Html Template String of list item inner content. */ set templateItemContent(value: string); /** When true, hides the entire toolbar and removes the space it occupies. */ set hideToolbar(value: boolean); get hideToolbar(): boolean; /** When set, clears all existing buttons from the toolbar's buttonset and rebuilds them in the specified order. * Valid values: 'add', 'up', 'down', 'edit', 'delete', 'separator'. */ set buttons(value: string[] | undefined); get buttons(): string[] | undefined; /** When set, excludes the specified buttons from the toolbar. * Valid values: 'add', 'up', 'down', 'edit', 'delete'. */ set excludeButtons(value: string[] | undefined); get excludeButtons(): string[] | undefined; /** Calls events after a top button action */ afteradd: EventEmitter; aftergoup: EventEmitter; aftergodown: EventEmitter; afterdelete: EventEmitter; /** Calls events before a top button action */ beforeedit: EventEmitter; beforeadd: EventEmitter; beforegoup: EventEmitter; beforegodown: EventEmitter; beforedelete: EventEmitter; /** Update event on arranging items (drag and drop item) */ arrangeupdate: EventEmitter; /** Calls events for edit item */ entereditmode: EventEmitter; exiteditmode: EventEmitter; ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoListBuilderModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoFormatDatePipe implements PipeTransform { /** * Formats the given date using the soho locale formats. * * @param value the date (or string), must not be null. * @param attribs optional, additional formatting settings. * @returns the translated resource string or undefined. * */ transform(value: string | Date, attribs?: any): string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } declare class SohoFormatNumberPipe implements PipeTransform { /** * Formats the given date using the soho locale formats. * * @param value the date (or string), must not be null. * @param attribs optional, additional formatting settings. * @returns the translated resource string or undefined. * */ transform(value: string | number, attribs?: any): string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } declare class SohoTranslatePipe implements PipeTransform { /** * Translates the specified string into the current locale. * * @param value the resource string, must not be null. * @param locale the locale to use, defaults to current locale. * @param options additional options passed to the locale translate function * @returns the translated resource string or undefined. * */ transform(value: string, locale?: string | undefined, options?: Object | undefined): string | undefined; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } declare class SohoLocaleModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class ArgumentHelper { /** * Checks the given parameter is not null, throws an exception if not. */ static checkNotNull(parameterName: string, arg: any): void; static checkNotEmpty(parameterName: string, arg: string): void; static checkInputNotNull(parentName: string, inputName: string, arg: any): void; static checkChildNotNull(parentName: string, childName: string, arg: any): void; } declare class DeprecatedEventEmitter extends EventEmitter { private deprecatedName; private newName; constructor(deprecatedName: string, newName: string); subscribe(generatorOrNext?: any, error?: any, complete?: any): Subscription; } declare class SohoIconUtils { /** * Returns the RAW HTML for creating a new icon in string form */ static createIcon(params: any): string; /** * Returns a jQuery-wrapped element containing a new icon */ static createIconElement(options: any): JQuery; /** * Returns just the path part */ static createIconPath(options: any): string; } /** * Static helper class for common test functionality */ declare class TestHelper { /** * Fire a soho or dom event where it's expected to be re-emitted by the passed in event emitter * * @param element The native element where the dom event is triggered from. * @param eventName The name of the event to trigger on the native element. * @param eventEmitter The angular event emitter that will be checked toHaveBeenCalled 1 time. */ static testFireEvent(element: HTMLElement, eventName: string, eventEmitter: EventEmitter): void; } declare class SohoLookupComponent extends BaseControlValueAccessor implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ngZone; /** * Used to call updated from the afterViewChecked lifecycle event. */ private updateRequired?; /** * API for interacting with modal and then in turn the buttons on the dialog. */ modal?: SohoModalStatic; /** * Available Soho Template control settings as Inputs * Should match the Soho properties for the component */ asobject: boolean; /** Grid columns. */ columns?: SohoDataGridColumn[]; /** * Changes the dataset being used */ set dataset(data: Object[] | undefined); get dataset(): Object[] | undefined; /** Custom click event; can be used with a modal dialog and custom list component */ set click(value: SohoLookupClickFunction | undefined); get click(): SohoLookupClickFunction | undefined; /** If a click method is defined, this flexible object can be passed in. */ set clickArguments(value: any); get clickArguments(): any; /** Custom clear event; can be used with a modal dialog and custom list component */ set clear(value: SohoLookupClearFunction | undefined); get clear(): SohoLookupClearFunction | undefined; /** If a clear method is defined, this flexible object can be passed in. */ set clearArguments(value: any); get clearArguments(): any; /** Field to return from the array or can be a function. */ set field(value: string | SohoLookupFieldFunction | undefined); get field(): string | SohoLookupFieldFunction | undefined; /** Dialog title or takes the label + Lookup. */ set title(value: string | undefined); get title(): string | undefined; /** Swap out the lookup id for any other icon in the icon set by name */ set icon(value: string | undefined); get icon(): string | undefined; /** Pass dialog buttons or Cancel / Apply. */ set buttons(value: SohoModalButton[] | undefined); get buttons(): SohoModalButton[] | undefined; /** Options to pass to the underlying data grid. */ set options(value: SohoDataGridOptions | undefined); get options(): SohoDataGridOptions | undefined; /** * Used to manage data prior to showing the lookup. * * For example: * - When the button is clicked, show a loading dialog and make the request for * lookup grid data. * - Upon receiving grid data, set lookup.settings.options for the columns and dataset. * - Then call grid() to build the grid and complete the lookup call. */ set beforeShow(value: SohoLookupBeforeShowFunction | undefined); get beforeShow(): SohoLookupBeforeShowFunction | undefined; /** Custom modal content. */ set modalContent(value: JQuery | string | undefined); get modalContent(): JQuery | string | undefined; /** Can the user type random text into the field. */ set editable(value: boolean | undefined); get editable(): boolean | undefined; /** If set to false the dialog wont apply the value on clicking a value. */ set autoApply(value: boolean | undefined); get autoApply(): boolean | undefined; /** Function used to match the search term to the data. */ set match(value: SohoDataGridMatchFunction | undefined); get match(): SohoDataGridMatchFunction | undefined; /** A function that fires to let you validate form items on open and select. */ set validator(value: SohoLookupValidatorFunction | undefined); get validator(): SohoLookupValidatorFunction | undefined; /** Set the width of the input to the width of the selection */ set autoWidth(value: boolean | undefined); get autoWidth(): boolean | undefined; /** The character used to separate data strings */ set delimiter(value: string | undefined); get delimiter(): string | undefined; /** Apply a minimum width to the lookup*/ set minWidth(value: number | undefined); get minWidth(): number | undefined; /** Add an ability to clear the lookup field with an x */ set clearable(value: boolean | undefined); get clearable(): boolean | undefined; /** Add extra attributes like id's to the component */ set attributes(attributes: Array | Object | undefined); get attributes(): Array | Object | undefined; /** Set the input to tabbable */ set tabbable(tabbable: boolean | undefined); get tabbable(): boolean | undefined; /** Set `no-margin` class to lookup wrapper */ set noMarginWrapper(noMarginWrapper: boolean | undefined); get noMarginWrapper(): boolean | undefined; /** Set custom CSS classes for lookup */ set cssClass(cssClass: string | undefined); get cssClass(): string | undefined; /** Set the input to allow duplicates */ set allowDuplicates(allowDuplicates: boolean | undefined); get allowDuplicates(): boolean | undefined; toolbarPlaceholder?: string; multiselect: boolean; name?: string; source?: SohoDataGridSourceFunction; toolbar?: SohoToolbarOptions; autoCompleteSettings?: SohoLookupAutoComplete; /** * Available Soho Template events as Output (EventEmitters passing the event) * Should match the Soho event names for the component */ afteropen: EventEmitter; start: EventEmitter; complete: EventEmitter; beforeopen: EventEmitter; change: EventEmitter; inputEvt: EventEmitter; open: EventEmitter; close: EventEmitter; selected: EventEmitter; afterpaging: EventEmitter; /** * Bind attributes to the host input element */ get isLookup(): boolean; /** * Is the lookup control disabled? */ _disabled: boolean | undefined; /** * Accessor for _disabled. */ get isDisabled(): boolean | undefined; set isDisabled(disabled: boolean | undefined); /** * Add class binding. */ get disabledClass(): boolean | undefined; /** * Is the lookup control readonly? */ _readonly: boolean | undefined; /** * Local variables */ private jQueryElement?; /** * Soho Lookup widget. * * @private */ private lookup?; /** * Autocomplete */ private autocomplete; private settings; /** Initial dataset */ private _dataset?; /** * Constructor. * * @param element associated element * @param ngZone angular zone */ constructor(element: ElementRef, ngZone: NgZone); onKeyUp(_event: KeyboardEvent): void; ngAfterViewInit(): void; /** * Update the selected rows */ updateSelectedRows(rows: any[]): void; /** * Find the row and select it based on select value / function / field value */ selectRowByValue(field: String, value: String): void; /** Get the selected rows and return them to the UI **/ insertRows(): void; /** Returns the rows currently selected **/ selectedRows(): any[]; /** Enable the input. **/ enable(): void; /** Disable the input. **/ disable(): void; /** Make the input readonly. **/ readonly(): void; /** Send in a new data set to display in the datagrid in the lookup. **/ updateDataset(dataset: Object[], pagerInfo: SohoPagerPagingInfo): void; /** * Call to notify the lookup about any dom/settings changes */ updated(settings?: any): void; /** * Sets the loading/busy indicator state for the modal element. */ setLoadingIndicator(show: boolean, options?: SohoBusyIndicatorOptions): void; /** * Destroys the modal lookup. */ destroy(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; isMultiselect(): boolean | undefined; modalOpened(args: any[]): void; /** * Handle the control being changed. */ onChange(event: SohoLookupChangeEvent[]): void; onAutocompleteChange(event: any): void; onAutocompleteSelected(event: any): void; onAutocompleteBeforeOpen(event: any): void; setDisabledState(isDisabled: boolean | undefined): void; /** * Needed to extract this function from the 'insertRows' function within the * Soho Lookup control object. * TODO: Expose this in the Sohoxi library @tim @ed.coyle * * @todo raise SOHO jira issue */ processValue(value: Object | Object[]): string; /** * Set lookup value to allow the lookup element to be updated correctly. * Used when the click property is set on the sohoxi control. * * @param event - selected row * TODO: Expose this in the Sohoxi library @tim @ed.coyle * * @todo raise SOHO jira issue */ setValue(event: SohoLookupChangeEvent[]): void; /** * Override writeValue to allow the lookup * element to be updated correctly. * * @param value - the new value */ writeValue(value: any): void; /** * Evaluate the event param and parse the value */ private parseValue; private markForUpdate; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoLookupModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoMaskDirective implements AfterViewInit, OnDestroy { private element; /** Private control options. */ private _options; private _patternOptions; private _symbols; /** Sets all the options. */ set options(value: SohoMaskOptions | string); /** Definitions of pattern(s) as a regular expression. */ set definitions(value: { [key: string]: RegExp; }); /** When true, appends the leftover characters in the placeholder to the conformed value. */ set guide(value: boolean); /** When true, keeps groups of character intact. */ set keepCharacterPositions(value: boolean); /** Function that replaces the internal masking functionality. */ set maskAPI(value: Function); /** * The pattern to use for the mask. * * This uses the sohoPrefix otherwise the pattern interferes * with the pattern on form groups. */ set sohoPattern(value: SohoMaskPattern); /** Function that is executed after the masking process is complete. */ set pipe(value: Function); /** The placeholder text for the mask. */ set placeholder(value: string); /** The placeholder character for the mask. */ set placeholderChar(value: string); /** Indicates special formatting rules may apply to the mask. */ set process(value: SohoMaskProcess); /** When true, the onblur event executes mask processing. */ set processOnBlur(value: boolean); /** Indicates to initially mask the value of the input field. */ set processOnInitialize(value: boolean); /** The pattern options. */ set patternOptions(value: SohoMaskPatternOptions | string); /** When true, the decimal separator symbol is allowed in a formatted number. */ set allowDecimal(value: boolean); /** When true, allows leading zeros in a formatted number. */ set allowLeadingZeros(value: boolean); /** When true, the negative symbol is allowed in a formatted number. */ set allowNegative(value: boolean); /** When true, adds the thousands separator symbol to the correct location in a formatted number. */ set allowThousandsSeparator(value: boolean); /** The maximum number of digits to the left of the decimal separator symbol in a formatted number. */ set decimalLimit(value: number); /** Shows trailing decimal zeroes in a formatter number. */ set allowTrailingDecimalZeros(value: number); /** The maximum number of digits to the right of decimal separator symbol in a formatted number. */ set integerLimit(value: number); /** The character that precedes the masked value. */ set prefix(value: string); /** When true, the decimal separator symbol is required in a formatted number. */ set requireDecimal(value: boolean); /** The character that follows the masked value. */ set suffix(value: string); /** The symbols to use for the formatted number. */ set symbols(value: SohoMaskPatternSymbols | string); /** The locale to use for the formatted number. */ set locale(value: string); /** The currency symbol to use for the formatted number. */ set currencySymbol(value: string); /** The decimal separator symbol to use for the formatted number. */ set decimalSymbol(value: string); /** The negative symbol to use for the formatted number. */ set negativeSymbol(value: string); /** The thousands separator symbol to use for the formatted number. */ set thousandsSymbol(value: string); /** * Indicates if each section of the group pattern match must be full in order for * the literals in-between each section to be automatically added (meaning you can't * type a literal to end that group until all characters in that group are entered). * * @deprecated not supported */ set groupComplete(_value: boolean); /** * Indicates special formatting rules may apply to the mask. * * @deprecated use process instead */ set mode(value: SohoMaskMode); /** * Indicates to complete the full mask or the mask will revert to empty. * * @deprecated not supported */ set mustComplete(_value: boolean); /** * Indicates you can enter the negative symbol in front of the number; * automatically set to true if a negative symbol is detected inside the mask. * * @deprecated use allowNegative instead */ set negative(value: boolean); /** * Option defined in control, but not referenced. * * @deprecated */ set number(_value: boolean); /** * Indicates the thousands separator for numbers (based on localization) will be * inserted wherever necessary during typing; automatically set to true if the * localized thousands separator is detected inside the mask. * * @deprecated use allowThousandsSeparator instead */ set thousandsSeparator(value: boolean); /** * Indicates to display the localized symbol for currency or percent; * backwards compatible with old 'data-show-currency'; value true equates to currency * * @deprecated use prefix or suffix instead */ set showSymbol(_value: SohoMaskShowSymbol); /** * Called when mask value changes */ write: EventEmitter; /** * Local variables */ private jQueryElement?; private mask?; constructor(element: ElementRef); ngAfterViewInit(): void; /** Destructor. */ ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵdir: i0.ɵɵDirectiveDeclaration; } declare class SohoMaskModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoMastheadComponent { get classes(): string; ariaLabel: string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoMastheadModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoMenuButtonComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private element; private ref; private ngZone; get isBtnMenu(): boolean; get buttonType(): string; /** The underlying jQuery instance. */ private jQueryElement?; /** The enterprise widget api. */ private menuButton?; /** The button widget api */ private button?; private options; private buttonOptions; /** * Flag to force an update of the control after the view is created. */ private runUpdatedOnCheck?; selected: EventEmitter; beforeopen: EventEmitter; /** * @todo remove override of native element */ open$: EventEmitter; /** * @todo remove override of native element */ close$: EventEmitter; /** The icon to be used. */ icon?: string; set autoFocus(value: boolean); set mouseFocus(value: boolean); set showArrow(value: boolean); set returnFocus(value: boolean); get returnFocus(): boolean; set trigger(trigger: SohoPopupMenuTrigger); set menu(menu: string | JQuery); set ajaxBeforeOpenFunction(fn: AjaxBeforeOpenFunction); set hideMenuArrow(value: boolean | undefined); get hideMenuArrow(): boolean | undefined; set offset(value: SohoPopupmenuOffset | undefined); get offset(): SohoPopupmenuOffset | undefined; set attachToBody(value: boolean | undefined); get attachToBody(): boolean | undefined; set removeOnDestroy(value: boolean | undefined); get removeOnDestroy(): boolean | undefined; set ripple(value: boolean | undefined); get ripple(): boolean | undefined; /** If true, the menu stays open when clicking outside or pressing Escape/Tab */ set keepOpen(value: boolean | undefined); get keepOpen(): boolean | undefined; constructor(element: ElementRef, ref: ChangeDetectorRef, ngZone: NgZone); ngAfterViewInit(): void; ngAfterViewChecked(): void; private onSelected; private onBeforeOpen; private onClose; private onOpen; updated(menuSettings?: SohoPopupMenuOptions, buttonSettings?: SohoButtonOptions): void; teardown(): void; close(): void; open(event: JQuery.TriggeredEvent, ajaxReturn?: boolean, useDelay?: boolean): void; ngOnDestroy(): void; /** * Marks the components as requiring a rebuild after the next update. */ markForRefresh(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoMenuButtonModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SohoMessageModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Wrapper for the jQuery modal control. */ declare class SohoMessageRef { /** Vetoable Event Guard */ private eventGuard; /** Selector referencing the modal-dialog after it has been moved to the dialog container. */ private jQueryElement?; /** Soho Control Api */ private _message?; /** The result of the dialog. */ private _dialogResult; /** Dialog placeholder, defaults to $('body')*/ private _placeholder; /** Event fired when the message is opened. */ private open$; /** * Cached options. */ private _options; /** * Sets the whole options block for this modal dialog. * * @param options - the options to set. */ options(options?: SohoMessageOptions): SohoMessageRef; /** * Sets the width for the dialog. * * @param width - the extra frame height to allow. */ frameHeight(width: number): SohoMessageRef; /** * Sets the title of the message dialog. * * @param title - the title of the dialog. */ title(title: string): SohoMessageRef; /** * Sets the buttons to use on the modal dialog. * * @param buttons - list of buttons to display */ buttons(buttons: SohoModalButton[]): SohoMessageRef; /** * Is this an error dialog? * * @param isError - true if this dialog is to be styled an an alert. */ isError(isError: boolean): SohoMessageRef; /** * Sets the 'message' that the message dialog displays. * * @param message - a selector or string representing the dialog content. */ message(message: string): SohoMessageRef; /** * Sets the 'status' of the modal control. */ status(status: string): SohoMessageRef; /** * Sets the 'cssClass' of the modal control. */ cssClass(cssClass: string): SohoMessageRef; /** * If true, it will show a close icon button on the top right of the message. * * @param showCloseBtn - if true, the x button will be shown. */ showCloseBtn(showCloseBtn: boolean): SohoMessageRef; /** * Sets the 'allowTags' of the modal control. */ allowedTags(allowedTags: string): SohoMessageRef; /** * Sets the element to focus on when the modal is closed. * * @param returnFocus - a jQuery element or CSS selector string of the element to focus. */ returnFocus(returnFocus: JQuery | string): SohoMessageRef; /** * If true, causes the modal's trigger element not to become focused once the modal is closed. * * @param noRefocus - if true, the trigger element will not be refocused. */ noRefocus(noRefocus: boolean): SohoMessageRef; /** * Controls the opacity of the background overlay. * * @param overlayOpacity - The percent between 0 and 1 of opacity to use. */ overlayOpacity(overlayOpacity: number): SohoMessageRef; /** * Causes this modal instance to become hidden when another modal is displayed over top. * * @param hideUnderneath - If it should be on top or bottom. */ hideUnderneath(hideUnderneath: boolean): SohoMessageRef; /** * Causes this modal instance to become hidden when another modal is displayed over top. * * @param hideUnderneath - If it should be on top or bottom. */ attributes(attributes: Array | Object): SohoMessageRef; /** * Dialog result property. * * @param dialogResult - the stored restult of the dialog. */ set dialogResult(dialogResult: any); get dialogResult(): any; /** * Constructor. * * @param placeholder for the dialog; defaults to the body. */ constructor(); /** * Displays the message. * * @return the dialog ref. */ open(): SohoMessageRef; /** * Closes the modal dialog, if open. * * @param dialogResult - optional result - held for the caller. */ close(dialogResult?: any): SohoMessageRef; /** * Registers a before open guard. * * @param eventFn - the function to call before openning the dialog. */ beforeOpen(eventFn: () => boolean): SohoMessageRef; /** * Opened Event. * * This event is fired when the dialog is being opened. * * @param eventFn - the function to invoke when the dialog is to be opened. */ opened(eventFn: Function): SohoMessageRef; /** * Registers a before close guard. * * @param eventFn - the function to call before closing the dialog. */ beforeClose(eventFn: () => boolean): SohoMessageRef; /** * Handles the 'beforeOpen' event, fired before the modal dialog * has been opened. * * @param event - full event object. * * @return true if the dialog can be opened; otherwise false if veoted. */ private onBeforeOpen; /** * Handles the 'beforeCloseEvent, fired before the modal dialog * is closed, allowing the closure to be vetoed. * * @param event - event object. * @return true if the dialog can be closed; otherwise false if veoted. */ private onBeforeClose; /** * Handles the 'open' event, fired just before * the focus is assigned to a message. * * @param event - full event object. */ private onOpen; } /** * This service is used to create message dialogs. */ declare class SohoMessageService { /** * Constructor. */ constructor(); /** * Creates a dialog defined by the given message, returning a reference to the * associated dialog that can be interacted with. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @parent options - a compete set of options; can be null. * * @return the message reference. */ message(options?: SohoMessageOptions): SohoMessageRef; /** * Creates an error message, defined by the given options. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @return the message reference. */ error(options?: SohoMessageOptions): SohoMessageRef; /** * Creates an alert message, defined by the given options. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @return the message reference. */ alert(options?: SohoMessageOptions): SohoMessageRef; /** * Creates an confirm (positive) message, defined by the given options. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @return the message reference. */ confirm(options?: SohoMessageOptions): SohoMessageRef; /** * Creates an info message, defined by the given options. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @return the message reference. */ info(options?: SohoMessageOptions): SohoMessageRef; /** * Creates an success message, defined by the given options. * * The dialog won't be open until open is called on the returned instance, * see the message ref api for further methods. * * @return the message reference. */ success(options?: SohoMessageOptions): SohoMessageRef; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } declare class SohoModalDialogModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Wrapper for the jQuery modal control. * */ declare class SohoModalDialogRef { private appRef; private injector; private ngZone; private service; /** Component - if the content is derived from an existing component. */ private componentRef?; /** Vetoable Event Guard */ private eventGuard; /** * Closes the modal dialogs if router navigation is detected, this prevents diaslogs from being * left open when navigating. */ private _closeOnNavigation; /** Selector referencing the modal-dialog after it has been moved to the dialog container. */ private jQueryElement?; /** Soho Control Api */ private modal?; /** The result of the dialog. */ private _dialogResult; /** Event fired when the modal is opened. */ private open$; /** Event fired when the modal is closed. */ private close$; /** Event fired after closing the modal. */ private afterClose$; /** Event fired after openning the modal dialog. */ private afterOpen$; /** Handle resource tidy up of this class. */ private destroyed$; /** * The component displayed inside the modal frame, if specified. This may * be null if the dialog is built from an HTML fragment or a jQuery selector. * * @returns the contained component dialog. */ get componentDialog(): T | undefined; /** * The buttonset API for the modal dialog. * * @returns the buttonset API for the modal dialog, if initialised. */ get buttonsetAPI(): SohoButtonsetStatic | undefined; /** * Cached options. */ private _options; /** * Sets the whole options block for this modal dialog. * * @param options - the options to set. */ options(options: SohoModalOptions): SohoModalDialogRef; /** * Sets the frame height for the dialog. * * @param frameHeight - the extra frame height to allow. */ frameHeight(frameHeight: number): SohoModalDialogRef; /** * Sets the frame width for the dialog. * * @param frameWidth - the extra frame width to allow. */ frameWidth(frameWidth: number): SohoModalDialogRef; /** * A call back function that can be used to return data for the modal. This is the callback form of the before show event. * * @param beforeShow - The callback function */ beforeShow(beforeShow: any): SohoModalDialogRef; /** * If true, show a close icon button on the top right of the modal. * * @param showCloseBtn - if true the x will be shown. */ showCloseBtn(showCloseBtn: boolean): SohoModalDialogRef; /** * Optional max width to add in pixels. * * @param maxWidth - The width in pixels */ maxWidth(maxWidth: number): SohoModalDialogRef; /** * Optional width to set the text of the buttonset. * * @param buttonsetTextWidth - The width of buttonset text. */ buttonsetTextWidth(buttonsetTextWidth: number | string): SohoModalDialogRef; /** * If true, adds tabindex="0" to the modal body wrapper for keyboard navigation of scrollable content. * * @param contentFocusable - Whether the modal content should be focusable. */ contentFocusable(contentFocusable: boolean): SohoModalDialogRef; /** * Sets the title of the modal dialog. * * @param title - the title of the dialog. */ title(title: string): SohoModalDialogRef; /** * Sets the icon of the modal dialog title * @param icon - the icon name without icon- */ icon(icon: string): SohoModalDialogRef; /** * Sets the class to add for color and placement on the icon * @param icon - the css class name */ iconClass(icon: string): SohoModalDialogRef; /** * Sets the buttons to use on the modal dialog. * * @param buttons - list of buttons to display */ buttons(buttons: SohoModalButton[]): SohoModalDialogRef; /** * Sets the 'id' that the modal control uses. * * @param id - the id. */ id(id: string): SohoModalDialogRef; /** * Sets the 'trigger' that the modal control uses. * * @param trigger - when to open the dialog. */ trigger(trigger: SohoModalTriggerType): SohoModalDialogRef; /** * Sets the 'isAlert' that the modal control uses. * * @param isAlert - true if this dialog is to be styled an an alert. */ isAlert(isAlert: boolean): SohoModalDialogRef; /** * Sets the fullsize configuration that the modal control uses. * * @param fullsize - The full size configuration to use. */ fullsize(fullsize: SohoModalFullSize): SohoModalDialogRef; /** * Sets the breakpoint configuration that the modal control uses in full size mode(s). * * @param breakpoint - The full size configuration to use. */ breakpoint(breakpoint: SohoModalBreakPoint): SohoModalDialogRef; /** * Controls the opacity of the background overlay. * * @param overlayOpacity - The percent between 0 and 1 of opacity to use. */ overlayOpacity(overlayOpacity: number): SohoModalDialogRef; /** * Causes this modal instance to become hidden when another modal is displayed over top. * * @param hideUnderneath - If it should be on top or bottom. */ hideUnderneath(hideUnderneath: boolean): SohoModalDialogRef; /** * if true, causes the modal to not exit when the enter key is pressed. * * @param suppressEnterKey - If it supress enter */ suppressEnterKey(suppressEnterKey: boolean): SohoModalDialogRef; /** * If true, causes the modal's trigger element not to become focused once the modal is closed. * * @param noRefocus - If true, refocus */ noRefocus(noRefocus: boolean): SohoModalDialogRef; /** * The modal's trigger element to keep refocused once the modal is closed. This can be html or jquery object or query selector as string. * * @param triggerButton - The element (for example a button) to refocus on close. */ triggerButton(triggerButton: boolean): SohoModalDialogRef; /** * Add extra attributes like id's to the component */ attributes(attributes: boolean): SohoModalDialogRef; /** * Sets the 'content' that the modal control uses. * * @param content - a selector or string representing the dialog content. */ content(content: JQuery | string): SohoModalDialogRef; /** * Sets the 'cssClass' of the modal control. */ cssClass(cssClass: string): SohoModalDialogRef; /** * Sets the 'autoFocus' of the modal control. * * @param autoFocus -if true; the dialog will autoFocus. */ autoFocus(autoFocus: boolean): SohoModalDialogRef; /** * Sets the 'noPadding' to remove paddings from the modal body wrapper. * @param noPadding - if true; the content will have no paddings. */ noPadding(noPadding: boolean): SohoModalDialogRef; /** * Sets the 'initialFocus' CSS selector for the element to focus on when the modal is opened. * * @param initialFocus - a CSS selector string targeting the element to focus. */ initialFocus(initialFocus: string): SohoModalDialogRef; /** * Applies a function to the instantiated component, * allowing the component to be modified, or initialised. * * The function is provided with a typed value for the * instance. * * @param component - the instantated instance. * @return the dialog ref for onward assignment. */ apply(fn: (component: T) => void): SohoModalDialogRef; /** * When set to true, this dialog is closed when navigation is detected. * * @param closeOnNavigation controls the close behaviour when navigating. * @return the dialog ref for support a fluent api. */ closeOnNavigation(closeOnNavigation: boolean): SohoModalDialogRef; /** * Dialog result property. * * @param dialogResult - the stored restult of the dialog. */ set dialogResult(dialogResult: any); get dialogResult(): any; /** * Constructor. * * @paran appRef - application reference used to insert the component. */ constructor(router: Router, appRef: ApplicationRef, componentFactoryResolver: ComponentFactoryResolver, injector: Injector, ngZone: NgZone, service: SohoModalDialogService, settings: SohoModalOptions, modalComponent?: ComponentType); /** * Opens the dialog. * * @return the dialog ref. */ open(): SohoModalDialogRef; /** * Closes the modal dialog, if open. The dialog is not closed * fully until the 'afterClosed' event is fired. * * @param dialogResult - optional result - passed back to the caller. */ close(dialogResult?: any): SohoModalDialogRef; /** * Destroys the modal dialog. */ destroy(): SohoModalDialogRef; /** * Registers a before open guard. * * SOHO-4892 - Returning false from beforeOpen or beforeDestroy breaks dialogs * * @param eventFn - the function to call before openning the dialog. */ beforeOpen(eventFn: (dialogRef?: SohoModalDialogRef) => boolean): SohoModalDialogRef; /** * Opened Event. * * This event is fired when the dialog is being opened. * * @param eventFn - the function to invoke when the dialog is to be opened. */ opened(eventFn: Function): SohoModalDialogRef; /** * Opened Event. * * This event is fired after the dialog has been opened. * * @param eventFn - the function to invoke when the dialog is to be opened. */ afterOpen(eventFn: Function): SohoModalDialogRef; /** * Registers a before close guard. * * @param eventFn - the function to call before closing the dialog. * @param isAsync - if callback is asynchronous or not */ beforeClose(eventFn: SohoModalDialogEventVetoFunction): SohoModalDialogRef; /** * Closed Event. * * This event is fired when the dialog is being closed. * * @param eventFn - the function to invoke when the dialog is to be closed. */ closed(eventFn: SohoModalDialogEventFunction): SohoModalDialogRef; /** * After Closed Event. * * This event is fired, with the result of the dialog, when the dialog has been * closed and destroyed. * * @param eventFn - the function to invoke after the dialog has been closed. */ afterClose(eventFn: SohoModalDialogEventFunction): SohoModalDialogRef; /** * Registers a before destroy guard. * * SOHO-4892 - Returning false from beforeOpen or beforeDestroy breaks dialogs * * @param eventFn - the function to call before destroying the dialog. */ beforeDestroy(eventFn: () => boolean): SohoModalDialogRef; /** * Handles the 'afterOpen' event, fired after the modal dialog * has been opened. * * @param event - full event object. */ private onAfterOpen; /** * Handles the 'beforeOpen' event, fired before the modal dialog * has been opened. * * @param event - full event object. * * @return true if the dialog can be opened; otherwise false if veoted. */ private onBeforeOpen; /** * Handles the 'beforeClose' event, fired before the modal dialog * has been destroyed. * * @param event - event object. * @return true if the dialog can be closed; otherwise false if veoted. */ private onBeforeClose; /** * Handles the 'beforeDestroy' event, fired before the modal dialog * has been destroyed. * * @param event - event object. * @return true if the dialog can be destroyed; otherwise false if veoted. */ private onBeforeDestroy; /** * Handles the 'open' event, fired just before * the focus is assigned to a modal. * * @param event - full event object. */ private onOpen; /** * Handles the close event. * * @param event - full event object. * @param isCancelled - is true if the cancel button was pressed; otherwise false. */ private onClose; /** * Handles the 'afterClose' event, fired when the dialog * has been closed and tidy up is required. * * @param event - full event object. */ private onAfterClose; } /** * Close/AfterClose event handler. * * @param result - the dialog result (if set); may be undefined. * @param dialogRef - the dialog reference (or wrapper); never null. * @param dialogComponent - the component hosted in the modal; may be undefined. */ type SohoModalDialogEventFunction = (result: any, dialogRef: SohoModalDialogRef, dialogComponent: T) => void; /** * BeforeClose event handler. * * @param dialogRef - the dialog reference; never null. */ type SohoModalDialogEventVetoFunction = (dialogRef: SohoModalDialogRef) => boolean | Promise; /** * Contract for all SohoModalDialogComponents. */ interface SohoModalComponent { } /** * Vetoable Event Handlers. */ interface SohoModalDialogVetoableEventGuard { /** * Track if cancelled */ isCancelled?: boolean; /** * Invoked before a modal is opened. * * @return false to veto the open action; otherwise true. */ beforeOpen?(dialogRef: SohoModalDialogRef): boolean; /** * Invoked before a modal is closed, allowing the close to be vetoed. * * @param result - the value of the dialog result, passed to close or set. * @param dialogRef - a reference to the modal dialog wrapper. * @param dialogComponent - the underlying dialog component displayed in the dialog. * @return false to veto the close action; otherwise true. */ beforeClose?(result: any, dialogRef: SohoModalDialogRef, dialogComponent: T): boolean; /** * Invoked before a modal is opened. * * @return false to veto the destroy action; otherwise true. */ beforeDestroy?(): boolean; } /** * This service is used to create a modal dialog, based on the content * of an Angular Componnent on the screen. */ declare class SohoModalDialogService { private readonly appRef; private readonly componentFactoryResolver; private readonly injector; private readonly ngZone; private readonly router; /** Tracks whether any modal is currently open to prevent duplicate instances from rapid triggers. */ _hasOpenModal: boolean; /** * Constructor. * * @param appRef - application reference; must not be null. * @param componentFactoryResolver - used to create component factories for components dynamically. * @param injector - the current in scope injector, use as a delegate. * @param ngZone - the angular zone; must not be null. * @router */ constructor(appRef: ApplicationRef, componentFactoryResolver: ComponentFactoryResolver, injector: Injector, ngZone: NgZone, router: Router); /** * Creates a modal dialog defined by the given component, returning a reference to the * dialog that can be interacted with. * * The component has the potential to include the dialog reference when it is * instantiated, as a provider. * * The dialog won't necessarily be open yet, see the dialog ref api for further methods. * * @param component - The type of the component to instantiate; must not be null. * @param parent - The parent container; obsolete but parameter kept for backwards API compatibility. Has no effect. * @param options - The control options to use. * * @return the modal dialog reference. */ modal(component: ComponentType, _parent?: ViewContainerRef, options?: SohoModalOptions): SohoModalDialogRef; /** * Creates a modal dialog (using the content defined in the options), returning a reference to the * dialog that can be interacted with. * * The dialog won't be open. * * @return the modal dialog reference. */ message(content: string | JQuery): SohoModalDialogRef; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; } /** * Object with a "new"" method returning the type T. */ type ComponentType = new (...args: any[]) => T; /** * Angular Wrapper for the Soho Module Nav control. * This Component attaches to an element annotated with the `soho-module-nav` attribute, */ declare class SohoModuleNavComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; /** Reference to the jQuery element. */ private jQueryElement?; /** Reference to the annotated SoHoXi control */ private modulenav?; /** Stored settings */ private _options; /** Internal use flags */ private _updateRequired; /** Constructor. */ constructor(elementRef: ElementRef, ngZone: NgZone); set accordionSettings(val: SohoAccordionOptions | undefined); get accordionSettings(): SohoAccordionOptions | undefined; set displayMode(val: SohoModuleNavDisplayMode | undefined); get displayMode(): SohoModuleNavDisplayMode | undefined; set mobileBehavior(val: boolean); get mobileBehavior(): boolean; set breakpoint(val: SohoModuleNavBreakPoint); get breakpoint(): SohoModuleNavBreakPoint; set showOverlay(val: boolean); get showOverlay(): boolean; set showModuleSwitcher(val: boolean); get showModuleSwitcher(): boolean; set showGuestSection(val: boolean); get showGuestSection(): boolean; set showSearchBar(val: boolean); get showSearchBar(): boolean; set enableOutsideClick(val: boolean); get enableOutsideClick(): boolean; set filterable(val: boolean); get filterable(): boolean; set initChildren(val: boolean); get initChildren(): boolean; set pinSections(val: boolean); get pinSections(): boolean; set showDetailView(val: boolean); get showDetailView(): boolean; displaymodechange: EventEmitter; accordionAPI(): SohoAccordionStatic | undefined; containerEl(): HTMLElement | undefined; switcherAPI(): SohoModuleNavSwitcherStatic | undefined; searchAPI(): SohoSearchFieldStatic | undefined; settingsAPI(): SohoModuleNavSettingsStatic | undefined; init(): void; /** Triggers a UI Resync. */ updated(val?: SohoModuleNavOptions): void; teardown(): void; /** * Updates the accordion and expands the target header * @param sohoModuleNavComponent * @param target */ updateLazy(sohoModuleNavComponent: SohoModuleNavComponent, target: any): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoModuleNavModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the Soho Module Nav Container element. * This Component attaches to an element annotated with the `soho-module-nav-container` attribute, */ declare class SohoModuleNavContainerComponent { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoModuleNavContainerModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the Soho Module Nav Settings element. * This Component attaches to an element annotated with the `soho-module-nav-settings` attribute, */ declare class SohoModuleNavSettingsComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; /** Reference to the jQuery element. */ private jQueryElement?; /** Reference to the annotated SoHoXi control */ private modulenavsettings?; /** Stored settings */ private _options; /** Internal use flags */ private _updateRequired; /** Constructor. */ constructor(elementRef: ElementRef, ngZone: NgZone); accordionAPI(): SohoAccordionStatic | undefined; accordionEl(): HTMLElement | undefined; menuAPI(): SohoPopupMenuStatic | undefined; init(): void; /** Triggers a UI Resync. */ updated(val?: SohoModuleNavSettingsOptions): void; teardown(): void; ngAfterViewInit(): void; ngAfterViewChecked(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SohoModuleNavSettingsModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * Angular Wrapper for the Soho Module Nav Switcher element. * This Component attaches to an element annotated with the `soho-module-nav-switcher` attribute, */ declare class SohoModuleNavSwitcherComponent implements AfterViewInit, AfterViewChecked, OnDestroy { private elementRef; private ngZone; /** Reference to the jQuery element. */ private jQueryElement?; /** Reference to the annotated SoHoXi control */ private modulenavswitcher?; /** Stored settings */ private _options; /** Internal use flags */ private _updateRequired; /** Constructor. */ constructor(elementRef: ElementRef, ngZone: NgZone); set displayMode(val: SohoModuleNavDisplayMode | undefined); get displayMode(): SohoModuleNavDisplayMode | undefined; set generate(val: boolean | undefined); get generate(): boolean | undefined; set changeIconOnSelect(val: boolean | undefined); get changeIconOnSelect(): boolean | undefined; set icon(val: SohoModuleNavSwitcherIconSetting); get icon(): SohoModuleNavSwitcherIconSetting; set noSearch(val: boolean | undefined); get noSearch(): boolean | undefined; set moduleButtonText(val: string | undefined); get moduleButtonText(): string | undefined; set roleDropdownLabel(val: string | undefined); get roleDropdownLabel(): string | undefined; set roles(val: Array | undefined); get roles(): Array | undefined; set disabled(val: boolean | undefined); get disabled(): boolean | undefined; rolechange: EventEmitter>; listcontextmenu: EventEmitter>; modulebuttonclick: EventEmitter>; accordionAPI(): SohoAccordionStatic | undefined; accordionEl(): HTMLElement | undefined; moduleButtonAPI(): SohoButtonStatic | undefined; roleDropdownAPI(): SohoDropDownStatic | undefined; init(): void; toggleModuleButtonFocus(doFocus?: boolean): void; /** Triggers a UI Resync. */ updated(val?: SohoModuleNavSwitcherOptions): void; teardown(): void; /** Sets the roles array programmatically */ setRoles(val: Array): void; /** Sets the current dropdown role using