@genesislcap/grid-pro 14.18.0 → 14.19.0

package/docs/api/grid-pro.gridprorenderertypes.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProRendererTypes](./grid-pro.gridprorenderertypes.md)
+
+## GridProRendererTypes enum
+
+The available Grid Pro Renderer Types
+
+**Signature:**
+
+```typescript
+export declare enum GridProRendererTypes 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  action | <code>&quot;action&quot;</code> |  |
+|  actionsMenu | <code>&quot;actionsMenu&quot;</code> |  |
+|  boolean | <code>&quot;boolean&quot;</code> |  |
+|  select | <code>&quot;select&quot;</code> |  |
+|  text | <code>&quot;text&quot;</code> |  |
+

package/docs/api/grid-pro.gridprotemplate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [gridProTemplate](./grid-pro.gridprotemplate.md)
+
+## gridProTemplate variable
+
+The Grid Pro Template.
+
+**Signature:**
+
+```typescript
+gridProTemplate: ViewTemplate
+```

package/docs/api/grid-pro.logger.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [logger](./grid-pro.logger.md)
+
+## logger variable
+
+Logger for the grid-pro package
+
+**Signature:**
+
+```typescript
+logger: import("@genesislcap/foundation-utils").Logger
+```

package/docs/api/grid-pro.md

@@ -0,0 +1,93 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md)
+
+## grid-pro package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [ActionRenderer](./grid-pro.actionrenderer.md) | The AG Action Renderer element. |
+|  [ActionsMenuRenderer](./grid-pro.actionsmenurenderer.md) | The Actions Menu Renderer element. |
+|  [AgTextFieldRenderer](./grid-pro.agtextfieldrenderer.md) | The AG Text Field Renderer element. |
+|  [AgTextRenderer](./grid-pro.agtextrenderer.md) |  |
+|  [BooleanRenderer](./grid-pro.booleanrenderer.md) | The AG Boolean Renderer element. |
+|  [GridColumn](./grid-pro.gridcolumn.md) | The Grid Pro Column element. |
+|  [GridPro](./grid-pro.gridpro.md) |  |
+|  [GridProCell](./grid-pro.gridprocell.md) | The Grid Pro Cell element. |
+|  [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) |  |
+|  [GridProGenesisDatasourceNext](./grid-pro.gridprogenesisdatasourcenext.md) |  |
+|  [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
+|  [StreamDatasource](./grid-pro.streamdatasource.md) |  |
+
+## Enumerations
+
+|  Enumeration | Description |
+|  --- | --- |
+|  [AgGridCSSVars](./grid-pro.aggridcssvars.md) | All official AG CSS variables |
+|  [AgGridTheme](./grid-pro.aggridtheme.md) | The available Grid Pro themes. |
+|  [GridProRendererTypes](./grid-pro.gridprorenderertypes.md) | The available Grid Pro Renderer Types |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [dateTimeValueFormatter({ value })](./grid-pro.datetimevalueformatter.md) | Returns a formatted date time value from the Grid Pro cell value. |
+|  [dateValueFormatter({ value })](./grid-pro.datevalueformatter.md) | Returns a formatted date value from the Grid Pro cell value. |
+|  [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [actionHeightMultiplier](./grid-pro.actionheightmultiplier.md) | The base height multiplier for the action renderer. |
+|  [agActionRendererStyles](./grid-pro.agactionrendererstyles.md) | The AG Action Renderer Styles. |
+|  [agBooleanRendererStyles](./grid-pro.agbooleanrendererstyles.md) | The AG Boolean Renderer Styles. |
+|  [agExternalStockStyles](./grid-pro.agexternalstockstyles.md) | All External AG Grid Stock in one CSS. |
+|  [agGridAlpineFontFace](./grid-pro.aggridalpinefontface.md) | The AG Alpine font face used on ag-theme-alpine/ag-theme-alpine-dark Grid Pro themes. |
+|  [agGridBalhamFontFace](./grid-pro.aggridbalhamfontface.md) | The AG Balham font face used on ag-theme-balham/ag-theme-balham-dark Grid Pro themes. |
+|  [agGridCSS](./grid-pro.aggridcss.md) | AG Grid core CSS. |
+|  [agGridMaterialFontFace](./grid-pro.aggridmaterialfontface.md) | The AG Material font face used on ag-theme-material Grid Pro theme. |
+|  [agHeadCSS](./grid-pro.agheadcss.md) | Custom Drag n Drop CSS for Grid Pro. |
+|  [agSelectRendererStyles](./grid-pro.agselectrendererstyles.md) | The AG Select Renderer Styles. |
+|  [agThemeAlpineNofontsCSS](./grid-pro.agthemealpinenofontscss.md) | AG Alpine Theme (no fonts) CSS. |
+|  [agThemeBalhamNofontsCSS](./grid-pro.agthemebalhamnofontscss.md) | AG Balham Theme (no fonts) CSS. |
+|  [agThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Font Face map with all the font faces for each theme. |
+|  [agThemeFontsId](./grid-pro.agthemefontsid.md) | Generates the id name for custom Grid Pro fonts. |
+|  [agThemeMaterialNofontsCSS](./grid-pro.agthemematerialnofontscss.md) | AG Material Theme (no fonts) CSS. |
+|  [agThemeTokenMapClassname](./grid-pro.agthemetokenmapclassname.md) | Generates the class name for a given Grid Pro theme name. |
+|  [agThemeTokenMapCSS](./grid-pro.agthemetokenmapcss.md) | Generates the CSS for a given GridPro theme name and token map |
+|  [CellTemplate](./grid-pro.celltemplate.md) | The Grid Pro Cell Template. |
+|  [ColumnTemplate](./grid-pro.columntemplate.md) | The Grid Pro Column Template. |
+|  [defaultAgGridFontFace](./grid-pro.defaultaggridfontface.md) | The default font face for Grid Pro (agGridAlpine). |
+|  [defaultGridProConfig](./grid-pro.defaultgridproconfig.md) |  |
+|  [foundationAgBooleanRenderer](./grid-pro.foundationagbooleanrenderer.md) | The Foundation Boolean Renderer registry. |
+|  [foundationAgSelectRenderer](./grid-pro.foundationagselectrenderer.md) | The Foundation Select Renderer registry. |
+|  [foundationAgTextFieldRenderer](./grid-pro.foundationagtextfieldrenderer.md) | The Foundation Text Field Renderer registry. |
+|  [foundationAgTextRenderer](./grid-pro.foundationagtextrenderer.md) | The Foundation Text Renderer registry. |
+|  [foundationGridComponents](./grid-pro.foundationgridcomponents.md) | The Grid Pro Components. |
+|  [foundationGridPro](./grid-pro.foundationgridpro.md) | The Foundation AgGrid |
+|  [foundationGridProActionRenderer](./grid-pro.foundationgridproactionrenderer.md) | The Foundation Action Renderer registry. |
+|  [foundationGridProActionsMenuRenderer](./grid-pro.foundationgridproactionsmenurenderer.md) | The Foundation Actions Menu Renderer registry. |
+|  [foundationGridProShadowOptions](./grid-pro.foundationgridproshadowoptions.md) |  |
+|  [foundationGridProStyles](./grid-pro.foundationgridprostyles.md) | The Grid Pro styles. |
+|  [getActionsMenuDef](./grid-pro.getactionsmenudef.md) | Helper function to get ColDef [https://www.ag-grid.com/javascript-data-grid/column-properties/](https://www.ag-grid.com/javascript-data-grid/column-properties/) for Actions Menu Renderer. Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified). |
+|  [getAgBooleanRendererTemplate](./grid-pro.getagbooleanrenderertemplate.md) | Get a Design System prefixed Checkbox template. |
+|  [getSelectRendererTemplate](./grid-pro.getselectrenderertemplate.md) | Get a Design System prefixed Select template. |
+|  [getTextFieldRendererTemplate](./grid-pro.gettextfieldrenderertemplate.md) | Get a Design System prefixed Text Field template. |
+|  [getTextRendererTemplate](./grid-pro.gettextrenderertemplate.md) |  |
+|  [gridProTemplate](./grid-pro.gridprotemplate.md) | The Grid Pro Template. |
+|  [logger](./grid-pro.logger.md) | Logger for the grid-pro package |
+|  [textFieldRendererStyles](./grid-pro.textfieldrendererstyles.md) | The AG Text Field Renderer Styles. |
+|  [textRendererStyles](./grid-pro.textrendererstyles.md) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [ActionRendererParams](./grid-pro.actionrendererparams.md) | Parameters for the [GridPro](./grid-pro.gridpro.md) action renderer. |
+|  [AgThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face. |
+|  [GridComponents](./grid-pro.gridcomponents.md) | Grid Pro Components type, used to define the custom components that will be registered in the grid |
+|  [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) |  |
+

package/docs/api/grid-pro.selectrenderer.destroy.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [destroy](./grid-pro.selectrenderer.destroy.md)
+
+## SelectRenderer.destroy() method
+
+**Signature:**
+
+```typescript
+destroy(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/grid-pro.selectrenderer.getgui.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [getGui](./grid-pro.selectrenderer.getgui.md)
+
+## SelectRenderer.getGui() method
+
+**Signature:**
+
+```typescript
+getGui(): HTMLElement;
+```
+**Returns:**
+
+HTMLElement
+

package/docs/api/grid-pro.selectrenderer.init.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [init](./grid-pro.selectrenderer.init.md)
+
+## SelectRenderer.init() method
+
+**Signature:**
+
+```typescript
+init(params: SelectCellRendererParams): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | SelectCellRendererParams |  |
+
+**Returns:**
+
+void
+

package/docs/api/grid-pro.selectrenderer.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md)
+
+## SelectRenderer class
+
+The AG Select Renderer element.
+
+**Signature:**
+
+```typescript
+export declare class SelectRenderer extends FoundationElement implements ICellRendererComp 
+```
+**Extends:** FoundationElement
+
+**Implements:** ICellRendererComp
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [params](./grid-pro.selectrenderer.params.md) |  | SelectCellRendererParams |  |
+|  [selectionChanged](./grid-pro.selectrenderer.selectionchanged.md) |  | (e: any) =&gt; void |  |
+|  [value](./grid-pro.selectrenderer.value.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [destroy()](./grid-pro.selectrenderer.destroy.md) |  |  |
+|  [getGui()](./grid-pro.selectrenderer.getgui.md) |  |  |
+|  [init(params)](./grid-pro.selectrenderer.init.md) |  |  |
+|  [refresh(params)](./grid-pro.selectrenderer.refresh.md) |  |  |
+

package/docs/api/grid-pro.selectrenderer.params.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [params](./grid-pro.selectrenderer.params.md)
+
+## SelectRenderer.params property
+
+**Signature:**
+
+```typescript
+params: SelectCellRendererParams;
+```

package/docs/api/grid-pro.selectrenderer.refresh.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [refresh](./grid-pro.selectrenderer.refresh.md)
+
+## SelectRenderer.refresh() method
+
+**Signature:**
+
+```typescript
+refresh(params: SelectCellRendererParams): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | SelectCellRendererParams |  |
+
+**Returns:**
+
+boolean
+

package/docs/api/grid-pro.selectrenderer.selectionchanged.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [selectionChanged](./grid-pro.selectrenderer.selectionchanged.md)
+
+## SelectRenderer.selectionChanged property
+
+**Signature:**
+
+```typescript
+selectionChanged: (e: any) => void;
+```

package/docs/api/grid-pro.selectrenderer.value.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [SelectRenderer](./grid-pro.selectrenderer.md) &gt; [value](./grid-pro.selectrenderer.value.md)
+
+## SelectRenderer.value property
+
+**Signature:**
+
+```typescript
+value: string;
+```

package/docs/api/grid-pro.streamdatasource._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [(constructor)](./grid-pro.streamdatasource._constructor_.md)
+
+## StreamDatasource.(constructor)
+
+Constructs a new instance of the `StreamDatasource` class
+
+**Signature:**
+
+```typescript
+constructor(options: StreamDatasourceOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) |  |
+

package/docs/api/grid-pro.streamdatasource.connect.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [connect](./grid-pro.streamdatasource.connect.md)
+
+## StreamDatasource.connect property
+
+**Signature:**
+
+```typescript
+connect: Connect;
+```

package/docs/api/grid-pro.streamdatasource.dataserverstream.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md)
+
+## StreamDatasource.dataserverStream property
+
+**Signature:**
+
+```typescript
+dataserverStream: SocketObservable<FilteredDataServerResult>;
+```

package/docs/api/grid-pro.streamdatasource.getrows.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [getRows](./grid-pro.streamdatasource.getrows.md)
+
+## StreamDatasource.getRows() method
+
+**Signature:**
+
+```typescript
+getRows(params: IServerSideGetRowsParams): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | IServerSideGetRowsParams |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.streamdatasource.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md)
+
+## StreamDatasource class
+
+**Signature:**
+
+```typescript
+export declare class StreamDatasource implements IServerSideDatasource 
+```
+**Implements:** IServerSideDatasource
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./grid-pro.streamdatasource._constructor_.md) |  | Constructs a new instance of the <code>StreamDatasource</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [connect](./grid-pro.streamdatasource.connect.md) |  | Connect |  |
+|  [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md) |  | SocketObservable&lt;FilteredDataServerResult&gt; |  |
+|  [resourceParams](./grid-pro.streamdatasource.resourceparams.md) |  | any |  |
+|  [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getRows(params)](./grid-pro.streamdatasource.getrows.md) |  |  |
+

package/docs/api/grid-pro.streamdatasource.resourceparams.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [resourceParams](./grid-pro.streamdatasource.resourceparams.md)
+
+## StreamDatasource.resourceParams property
+
+**Signature:**
+
+```typescript
+resourceParams: any;
+```

package/docs/api/grid-pro.streamdatasource.streamsourceref.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md)
+
+## StreamDatasource.streamSourceRef property
+
+**Signature:**
+
+```typescript
+streamSourceRef: string;
+```

package/docs/api/grid-pro.streamdatasourceoptions.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md)
+
+## StreamDatasourceOptions type
+
+**Signature:**
+
+```typescript
+export type StreamDatasourceOptions = {
+    stream: SocketObservable<FilteredDataServerResult>;
+    resourceName: string;
+    resourceParams?: any;
+    resourceIndexes?: Map<string, [string]>;
+    resourceColDefs?: MetadataDetail[];
+    maxRows?: number;
+    maxView?: number;
+    pagination?: boolean;
+};
+```

package/docs/api/grid-pro.textfieldrendererstyles.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [textFieldRendererStyles](./grid-pro.textfieldrendererstyles.md)
+
+## textFieldRendererStyles variable
+
+The AG Text Field Renderer Styles.
+
+**Signature:**
+
+```typescript
+textFieldRendererStyles: import("@microsoft/fast-element").ElementStyles
+```

package/docs/api/grid-pro.textrendererstyles.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [textRendererStyles](./grid-pro.textrendererstyles.md)
+
+## textRendererStyles variable
+
+> Warning: This API is now obsolete.
+> 
+> - Use textFieldRendererStyles instead
+> 
+
+**Signature:**
+
+```typescript
+textRendererStyles: import("@microsoft/fast-element").ElementStyles
+```

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/grid-pro](./grid-pro.md) |  |
+