UNPKG

1.15 kBTypeScriptView Raw
1import { LayoutBase } from '../layout-base';
2import { Property } from '../../core/properties';
3import { View } from '../../core/view';
4import { CoreTypes } from '../../../core-types';
5
6/**
7 * A Layout that arranges its children at its outer edges, and allows its last child to take up the remaining space.
8 */
9export class DockLayout extends LayoutBase {
10 /**
11 * Gets the value of the Dock property from a given View.
12 */
13 static getDock(view: View): CoreTypes.DockType;
14
15 /**
16 * Sets the value of the Dock property from a given View.
17 */
18 static setDock(view: View, value: CoreTypes.DockType): void;
19
20 /**
21 * Gets or sets a value that indicates whether the last child element within a DockLayout stretches to fill the remaining available space.
22 * The default value is true.
23 */
24 stretchLastChild: boolean;
25}
26
27/**
28 * Represents the observable property backing the dock property.
29 */
30export const dockProperty: Property<DockLayout, CoreTypes.DockType>;
31
32/**
33 * Represents the observable property backing the stretchLastChild property of each DockLayout instance.
34 */
35export const stretchLastChildProperty: Property<DockLayout, boolean>;