devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
691 lines (578 loc) • 19.4 kB
TypeScript
/*!
* devextreme-angular
* Version: 20.2.5
* Build date: Fri Jan 15 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
import { TransferState } from '@angular/platform-browser';
import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core';
import DevExpress from 'devextreme/bundles/dx.all';
import { format } from 'devextreme/ui/widget/ui.widget';
import { Font } from 'devextreme/viz/core/base_widget';
import DxSankey from 'devextreme/viz/sankey';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
/**
* The Sankey is a UI component that visualizes the flow magnitude between value sets. The values being connected are called nodes; the connections - links. The higher the flow magnitude, the wider the link is.
*/
export declare class DxSankeyComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxSankey;
/**
* Specifies adaptive layout properties.
*/
adaptiveLayout: {
height?: number;
keepLabels?: boolean;
width?: number;
};
/**
* Aligns node columns vertically.
*/
alignment: string | Array<string>;
/**
* Binds the UI component to data.
*/
dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>;
/**
* Specifies whether the UI component responds to user interaction.
*/
disabled: boolean;
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
elementAttr: any;
/**
* Configures the exporting and printing features.
*/
export: {
backgroundColor?: string;
enabled?: boolean;
fileName?: string;
formats?: Array<string>;
margin?: number;
printingEnabled?: boolean;
proxyUrl?: string;
svgToCanvas?: Function;
};
/**
* Specifies whether nodes and links change their style when they are hovered over or pressed.
*/
hoverEnabled: boolean;
/**
* Configures sankey nodes' labels.
*/
label: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
customizeText?: Function;
font?: DevExpress.viz.Font;
horizontalOffset?: number;
overlappingBehavior?: string;
shadow?: {
blur?: number;
color?: string;
offsetX?: number;
offsetY?: number;
opacity?: number;
};
useNodeColors?: boolean;
verticalOffset?: number;
visible?: boolean;
};
/**
* Configures sankey links' appearance.
*/
link: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
colorMode?: string;
hoverStyle?: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hatching?: {
direction?: string;
opacity?: number;
step?: number;
width?: number;
};
opacity?: number;
};
opacity?: number;
};
/**
* Configures the loading indicator.
*/
loadingIndicator: {
backgroundColor?: string;
enabled?: boolean;
font?: Font;
show?: boolean;
text?: string;
};
/**
* Generates space around the UI component.
*/
margin: {
bottom?: number;
left?: number;
right?: number;
top?: number;
};
/**
* Configures sankey nodes' appearance.
*/
node: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hoverStyle?: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hatching?: {
direction?: string;
opacity?: number;
step?: number;
width?: number;
};
opacity?: number;
};
opacity?: number;
padding?: number;
width?: number;
};
/**
* Sets the palette to be used to colorize sankey nodes.
*/
palette: string | Array<string>;
/**
* Specifies how to extend the palette when it contains less colors than the number of sankey nodes.
*/
paletteExtensionMode: string;
/**
* Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.
*/
pathModified: boolean;
/**
* Specifies whether to redraw the UI component when the size of the parent browser window changes or a mobile device rotates.
*/
redrawOnResize: boolean;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: boolean;
/**
* Specifies the UI component's size in pixels.
*/
size: {
height?: number;
width?: number;
};
/**
* Specifies nodes' sorting order in their columns.
*/
sortData: any;
/**
* Specifies which data source field provides links' source nodes.
*/
sourceField: string;
/**
* Specifies which data source field provides links' target nodes.
*/
targetField: string;
/**
* Sets the name of the theme the UI component uses.
*/
theme: string;
/**
* Configures the UI component's title.
*/
title: string | {
font?: Font;
horizontalAlignment?: string;
margin?: number | {
bottom?: number;
left?: number;
right?: number;
top?: number;
};
placeholderSize?: number;
subtitle?: string | {
font?: DevExpress.viz.Font;
offset?: number;
text?: string;
textOverflow?: string;
wordWrap?: string;
};
text?: string;
textOverflow?: string;
verticalAlignment?: string;
wordWrap?: string;
};
/**
* Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer.
*/
tooltip: {
arrowLength?: number;
border?: {
color?: string;
dashStyle?: string;
opacity?: number;
visible?: boolean;
width?: number;
};
color?: string;
container?: Element | JQuery | string;
cornerRadius?: number;
customizeLinkTooltip?: Function;
customizeNodeTooltip?: Function;
enabled?: boolean;
font?: Font;
format?: format | string;
linkTooltipTemplate?: any;
nodeTooltipTemplate?: any;
opacity?: number;
paddingLeftRight?: number;
paddingTopBottom?: number;
shadow?: {
blur?: number;
color?: string;
offsetX?: number;
offsetY?: number;
opacity?: number;
};
zIndex?: number;
};
/**
* Specifies which data source field provides links' weights.
*/
weightField: string;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<any>;
/**
* A function that is executed when the UI component's rendering has finished.
*/
onDrawn: EventEmitter<any>;
/**
* A function that is executed after the UI component is exported.
*/
onExported: EventEmitter<any>;
/**
* A function that is executed before the UI component is exported.
*/
onExporting: EventEmitter<any>;
/**
* A function that is executed before a file with exported UI component is saved to the user's local storage.
*/
onFileSaving: EventEmitter<any>;
/**
* A function that is executed when an error or warning occurs.
*/
onIncidentOccurred: EventEmitter<any>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<any>;
/**
* A function that is executed when a sankey link is clicked or tapped.
*/
onLinkClick: EventEmitter<any>;
/**
* A function that is executed after the pointer enters or leaves a sankey link.
*/
onLinkHoverChanged: EventEmitter<any>;
/**
* A function that is executed when a sankey node is clicked or tapped.
*/
onNodeClick: EventEmitter<any>;
/**
* A function that is executed after the pointer enters or leaves a sankey node.
*/
onNodeHoverChanged: EventEmitter<any>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
adaptiveLayoutChange: EventEmitter<{
height?: number;
keepLabels?: boolean;
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
alignmentChange: EventEmitter<string | Array<string>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
exportChange: EventEmitter<{
backgroundColor?: string;
enabled?: boolean;
fileName?: string;
formats?: Array<string>;
margin?: number;
printingEnabled?: boolean;
proxyUrl?: string;
svgToCanvas?: Function;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hoverEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
labelChange: EventEmitter<{
border?: {
color?: string;
visible?: boolean;
width?: number;
};
customizeText?: Function;
font?: DevExpress.viz.Font;
horizontalOffset?: number;
overlappingBehavior?: string;
shadow?: {
blur?: number;
color?: string;
offsetX?: number;
offsetY?: number;
opacity?: number;
};
useNodeColors?: boolean;
verticalOffset?: number;
visible?: boolean;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
linkChange: EventEmitter<{
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
colorMode?: string;
hoverStyle?: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hatching?: {
direction?: string;
opacity?: number;
step?: number;
width?: number;
};
opacity?: number;
};
opacity?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
loadingIndicatorChange: EventEmitter<{
backgroundColor?: string;
enabled?: boolean;
font?: Font;
show?: boolean;
text?: string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
marginChange: EventEmitter<{
bottom?: number;
left?: number;
right?: number;
top?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
nodeChange: EventEmitter<{
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hoverStyle?: {
border?: {
color?: string;
visible?: boolean;
width?: number;
};
color?: string;
hatching?: {
direction?: string;
opacity?: number;
step?: number;
width?: number;
};
opacity?: number;
};
opacity?: number;
padding?: number;
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
paletteChange: EventEmitter<string | Array<string>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
paletteExtensionModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
pathModifiedChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
redrawOnResizeChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
sizeChange: EventEmitter<{
height?: number;
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
sortDataChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
sourceFieldChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
targetFieldChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
themeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
titleChange: EventEmitter<string | {
font?: Font;
horizontalAlignment?: string;
margin?: number | {
bottom?: number;
left?: number;
right?: number;
top?: number;
};
placeholderSize?: number;
subtitle?: string | {
font?: DevExpress.viz.Font;
offset?: number;
text?: string;
textOverflow?: string;
wordWrap?: string;
};
text?: string;
textOverflow?: string;
verticalAlignment?: string;
wordWrap?: string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tooltipChange: EventEmitter<{
arrowLength?: number;
border?: {
color?: string;
dashStyle?: string;
opacity?: number;
visible?: boolean;
width?: number;
};
color?: string;
container?: Element | JQuery | string;
cornerRadius?: number;
customizeLinkTooltip?: Function;
customizeNodeTooltip?: Function;
enabled?: boolean;
font?: Font;
format?: format | string;
linkTooltipTemplate?: any;
nodeTooltipTemplate?: any;
opacity?: number;
paddingLeftRight?: number;
paddingTopBottom?: number;
shadow?: {
blur?: number;
color?: string;
offsetX?: number;
offsetY?: number;
opacity?: number;
};
zIndex?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
weightFieldChange: EventEmitter<string>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxSankey;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
}
export declare class DxSankeyModule {
}