IFluidLayoutDescriptor
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Fluid Layout descriptor. Provides parameters of fluid layout.
export interface IFluidLayoutDescriptor extends ILayoutDescriptor
Extends: ILayoutDescriptor
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
number | (ALPHA) Total number of grid columns. Used if visualization should take 100% width by its size | ||
number | (ALPHA) Height of one grid row in px. It is used for conversion of height between grid rows and px | ||
“fluid” | (ALPHA) |
Methods
Method | Description |
|---|---|
(ALPHA) Converts height in px to the height in layout units | |
(ALPHA) Converts height in layout units to the height in px |
Property details
IFluidLayoutDescriptor.gridColumnsCountpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Total number of grid columns. Used if visualization should take 100% width by its size
gridColumnsCount: number;
IFluidLayoutDescriptor.gridRowHeightpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Height of one grid row in px. It is used for conversion of height between grid rows and px
gridRowHeight: number;
IFluidLayoutDescriptor.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: "fluid";
Method details
IFluidLayoutDescriptor.toGridHeight()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Converts height in px to the height in layout units
toGridHeight(heightPx: number): number;
Parameters
Parameter | Type | Description |
|---|---|---|
heightPx | number |
Returns
number
IFluidLayoutDescriptor.toHeightInPx()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Converts height in layout units to the height in px
toHeightInPx(height: number): number;
Parameters
Parameter | Type | Description |
|---|---|---|
height | number |
Returns
number