update docs
This commit is contained in:
Chris Trevino
Родитель
c4e84f121b
Коммит
8f78e96e0c
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [BooleanOperation](./boolean-expression-component.booleanoperation.md)
|
||||
|
||||
## BooleanOperation enum
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum BooleanOperation
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| AND | <code>"and"</code> | |
|
||||
| OR | <code>"or"</code> | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [BooleanOperationMap](./boolean-expression-component.booleanoperationmap.md) > [\_\_global\_\_](./boolean-expression-component.booleanoperationmap.__global__.md)
|
||||
|
||||
## BooleanOperationMap.\_\_global\_\_ property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
__global__: BooleanOperation;
|
||||
```
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [BooleanOperationMap](./boolean-expression-component.booleanoperationmap.md)
|
||||
|
||||
## BooleanOperationMap interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface BooleanOperationMap
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [\_\_global\_\_](./boolean-expression-component.booleanoperationmap.__global__.md) | | [BooleanOperation](./boolean-expression-component.booleanoperation.md) | |
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [BooleanOperationToggle](./boolean-expression-component.booleanoperationtoggle.md)
|
||||
|
||||
## BooleanOperationToggle variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
BooleanOperationToggle: React.FC<{
|
||||
className?: string;
|
||||
style?: CSSProperties;
|
||||
operation: BooleanOperation;
|
||||
disabled?: boolean;
|
||||
onToggle?: () => void;
|
||||
palette?: Palette;
|
||||
}>
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [DEFAULT\_PALETTE](./boolean-expression-component.default_palette.md)
|
||||
|
||||
## DEFAULT\_PALETTE variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
DEFAULT_PALETTE: Palette
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClause](./boolean-expression-component.filterclause.md) > [id](./boolean-expression-component.filterclause.id.md)
|
||||
|
||||
## FilterClause.id property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClause](./boolean-expression-component.filterclause.md) > [label](./boolean-expression-component.filterclause.label.md)
|
||||
|
||||
## FilterClause.label property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
label: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClause](./boolean-expression-component.filterclause.md)
|
||||
|
||||
## FilterClause interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterClause
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [id](./boolean-expression-component.filterclause.id.md) | | string | |
|
||||
| [label](./boolean-expression-component.filterclause.label.md) | | string | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) > [filters](./boolean-expression-component.filterclausegroup.filters.md)
|
||||
|
||||
## FilterClauseGroup.filters property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
filters: FilterClause[];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) > [id](./boolean-expression-component.filterclausegroup.id.md)
|
||||
|
||||
## FilterClauseGroup.id property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) > [label](./boolean-expression-component.filterclausegroup.label.md)
|
||||
|
||||
## FilterClauseGroup.label property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
label: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) > [locked](./boolean-expression-component.filterclausegroup.locked.md)
|
||||
|
||||
## FilterClauseGroup.locked property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
locked?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md)
|
||||
|
||||
## FilterClauseGroup interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface FilterClauseGroup
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [filters](./boolean-expression-component.filterclausegroup.filters.md) | | [FilterClause](./boolean-expression-component.filterclause.md)<!-- -->\[\] | |
|
||||
| [id](./boolean-expression-component.filterclausegroup.id.md) | | string | |
|
||||
| [label](./boolean-expression-component.filterclausegroup.label.md) | | string | |
|
||||
| [locked?](./boolean-expression-component.filterclausegroup.locked.md) | | boolean | <i>(Optional)</i> |
|
||||
| [operation](./boolean-expression-component.filterclausegroup.operation.md) | | [BooleanOperation](./boolean-expression-component.booleanoperation.md) | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) > [operation](./boolean-expression-component.filterclausegroup.operation.md)
|
||||
|
||||
## FilterClauseGroup.operation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
operation: BooleanOperation;
|
||||
```
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [FilterExpressionView](./boolean-expression-component.filterexpressionview.md)
|
||||
|
||||
## FilterExpressionView variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
FilterExpressionView: React.FC<{
|
||||
filters: FilterClauseGroup[];
|
||||
operation: BooleanOperation;
|
||||
palette?: Palette;
|
||||
onGlobalOperationChanged?: (data: BooleanOperation) => void;
|
||||
onChipDismissed?: (filter: FilterClause) => void;
|
||||
onOperationChanged?: (id: string, operation: BooleanOperation) => void;
|
||||
onChipGroupDismissed?: (filterGroup: FilterClauseGroup) => void;
|
||||
}>
|
||||
```
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md)
|
||||
|
||||
## boolean-expression-component package
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [BooleanOperation](./boolean-expression-component.booleanoperation.md) | |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [toggleOperation(op)](./boolean-expression-component.toggleoperation.md) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [BooleanOperationMap](./boolean-expression-component.booleanoperationmap.md) | |
|
||||
| [FilterClause](./boolean-expression-component.filterclause.md) | |
|
||||
| [FilterClauseGroup](./boolean-expression-component.filterclausegroup.md) | |
|
||||
| [Palette](./boolean-expression-component.palette.md) | |
|
||||
| [WithChildren](./boolean-expression-component.withchildren.md) | |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [BooleanOperationToggle](./boolean-expression-component.booleanoperationtoggle.md) | |
|
||||
| [DEFAULT\_PALETTE](./boolean-expression-component.default_palette.md) | |
|
||||
| [FilterExpressionView](./boolean-expression-component.filterexpressionview.md) | |
|
||||
| [NO\_OP](./boolean-expression-component.no_op.md) | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [NO\_OP](./boolean-expression-component.no_op.md)
|
||||
|
||||
## NO\_OP variable
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
NO_OP: () => void
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [Palette](./boolean-expression-component.palette.md) > [backgroundColor](./boolean-expression-component.palette.backgroundcolor.md)
|
||||
|
||||
## Palette.backgroundColor property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backgroundColor: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [Palette](./boolean-expression-component.palette.md)
|
||||
|
||||
## Palette interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Palette
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [backgroundColor](./boolean-expression-component.palette.backgroundcolor.md) | | string | |
|
||||
| [operations](./boolean-expression-component.palette.operations.md) | | { \[[BooleanOperation.AND](./boolean-expression-component.booleanoperation.md)<!-- -->\]: string; \[[BooleanOperation.OR](./boolean-expression-component.booleanoperation.md)<!-- -->\]: string; } | |
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [Palette](./boolean-expression-component.palette.md) > [operations](./boolean-expression-component.palette.operations.md)
|
||||
|
||||
## Palette.operations property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
operations: {
|
||||
[BooleanOperation.AND]: string;
|
||||
[BooleanOperation.OR]: string;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [toggleOperation](./boolean-expression-component.toggleoperation.md)
|
||||
|
||||
## toggleOperation() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function toggleOperation(op: BooleanOperation): BooleanOperation;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| op | [BooleanOperation](./boolean-expression-component.booleanoperation.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[BooleanOperation](./boolean-expression-component.booleanoperation.md)
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [WithChildren](./boolean-expression-component.withchildren.md) > [children](./boolean-expression-component.withchildren.children.md)
|
||||
|
||||
## WithChildren.children property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
children?: ReactNode;
|
||||
```
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/boolean-expression-component](./boolean-expression-component.md) > [WithChildren](./boolean-expression-component.withchildren.md)
|
||||
|
||||
## WithChildren interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface WithChildren
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [children?](./boolean-expression-component.withchildren.children.md) | | ReactNode | <i>(Optional)</i> |
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md)
|
||||
|
||||
## API Reference
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Description |
|
||||
| --- | --- |
|
||||
| [@essex/boolean-expression-component](./boolean-expression-component.md) | |
|
||||
|
||||
|
|
@ -0,0 +1,924 @@
|
|||
{
|
||||
"metadata": {
|
||||
"toolPackage": "@microsoft/api-extractor",
|
||||
"toolVersion": "7.29.2",
|
||||
"schemaVersion": 1009,
|
||||
"oldestForwardsCompatibleVersion": 1001,
|
||||
"tsdocConfig": {
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
||||
"noStandardTags": true,
|
||||
"tagDefinitions": [
|
||||
{
|
||||
"tagName": "@alpha",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@beta",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@defaultValue",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@decorator",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@deprecated",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@eventProperty",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@example",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@experimental",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@inheritDoc",
|
||||
"syntaxKind": "inline"
|
||||
},
|
||||
{
|
||||
"tagName": "@internal",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@label",
|
||||
"syntaxKind": "inline"
|
||||
},
|
||||
{
|
||||
"tagName": "@link",
|
||||
"syntaxKind": "inline",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@override",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@packageDocumentation",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@param",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@privateRemarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@public",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@readonly",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@remarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@returns",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@sealed",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@see",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@throws",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@typeParam",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@virtual",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@betaDocumentation",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@internalRemarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@preapproved",
|
||||
"syntaxKind": "modifier"
|
||||
}
|
||||
],
|
||||
"supportForTags": {
|
||||
"@alpha": true,
|
||||
"@beta": true,
|
||||
"@defaultValue": true,
|
||||
"@decorator": true,
|
||||
"@deprecated": true,
|
||||
"@eventProperty": true,
|
||||
"@example": true,
|
||||
"@experimental": true,
|
||||
"@inheritDoc": true,
|
||||
"@internal": true,
|
||||
"@label": true,
|
||||
"@link": true,
|
||||
"@override": true,
|
||||
"@packageDocumentation": true,
|
||||
"@param": true,
|
||||
"@privateRemarks": true,
|
||||
"@public": true,
|
||||
"@readonly": true,
|
||||
"@remarks": true,
|
||||
"@returns": true,
|
||||
"@sealed": true,
|
||||
"@see": true,
|
||||
"@throws": true,
|
||||
"@typeParam": true,
|
||||
"@virtual": true,
|
||||
"@betaDocumentation": true,
|
||||
"@internalRemarks": true,
|
||||
"@preapproved": true
|
||||
},
|
||||
"reportUnsupportedHtmlElements": false
|
||||
}
|
||||
},
|
||||
"kind": "Package",
|
||||
"canonicalReference": "@essex/boolean-expression-component!",
|
||||
"docComment": "",
|
||||
"name": "@essex/boolean-expression-component",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "EntryPoint",
|
||||
"canonicalReference": "@essex/boolean-expression-component!",
|
||||
"name": "",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "Enum",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export declare enum BooleanOperation "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "BooleanOperation",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "EnumMember",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation.AND:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "AND = "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "\"and\""
|
||||
}
|
||||
],
|
||||
"initializerTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
},
|
||||
"releaseTag": "Public",
|
||||
"name": "AND"
|
||||
},
|
||||
{
|
||||
"kind": "EnumMember",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation.OR:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "OR = "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "\"or\""
|
||||
}
|
||||
],
|
||||
"initializerTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
},
|
||||
"releaseTag": "Public",
|
||||
"name": "OR"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperationMap:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface BooleanOperationMap "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "BooleanOperationMap",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperationMap#__global__:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "__global__: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "__global__",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "IndexSignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperationMap:index(1)",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "[key: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "]: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"returnTypeTokenRange": {
|
||||
"startIndex": 3,
|
||||
"endIndex": 4
|
||||
},
|
||||
"releaseTag": "Public",
|
||||
"overloadIndex": 1,
|
||||
"parameters": [
|
||||
{
|
||||
"parameterName": "key",
|
||||
"parameterTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
},
|
||||
"isOptional": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
},
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperationToggle:var",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "BooleanOperationToggle: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "React.FC",
|
||||
"canonicalReference": "@types/react!~React.FC:type"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "<{\n className?: string;\n style?: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "CSSProperties",
|
||||
"canonicalReference": "@types/react!~React.CSSProperties:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";\n operation: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";\n disabled?: boolean;\n onToggle?: () => void;\n palette?: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "Palette",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";\n}>"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "BooleanOperationToggle",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 9
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/boolean-expression-component!DEFAULT_PALETTE:var",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "DEFAULT_PALETTE: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "Palette",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette:interface"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "DEFAULT_PALETTE",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClause:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface FilterClause "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "FilterClause",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClause#id:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "id: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "id",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClause#label:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "label: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "label",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface FilterClauseGroup "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "FilterClauseGroup",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup#filters:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "filters: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "FilterClause",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClause:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "[]"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "filters",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 3
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup#id:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "id: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "id",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup#label:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "label: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "label",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup#locked:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "locked?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "boolean"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "locked",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup#operation:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "operation: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "operation",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
},
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterExpressionView:var",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "FilterExpressionView: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "React.FC",
|
||||
"canonicalReference": "@types/react!~React.FC:type"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "<{\n filters: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "FilterClauseGroup",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "[];\n operation: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";\n palette?: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "Palette",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";\n onGlobalOperationChanged?: (data: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ") => void;\n onChipDismissed?: (filter: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "FilterClause",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClause:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ") => void;\n onOperationChanged?: (id: string, operation: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ") => void;\n onChipGroupDismissed?: (filterGroup: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "FilterClauseGroup",
|
||||
"canonicalReference": "@essex/boolean-expression-component!FilterClauseGroup:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ") => void;\n}>"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "FilterExpressionView",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 17
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/boolean-expression-component!NO_OP:var",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "NO_OP: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "() => void"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "NO_OP",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface Palette "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "Palette",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette#backgroundColor:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "backgroundColor: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "backgroundColor",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!Palette#operations:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "operations: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "{\n ["
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation.AND",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation.AND:member"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "]: string;\n ["
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation.OR",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation.OR:member"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "]: string;\n }"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "operations",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 6
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
},
|
||||
{
|
||||
"kind": "Function",
|
||||
"canonicalReference": "@essex/boolean-expression-component!toggleOperation:function(1)",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export declare function toggleOperation(op: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "): "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "BooleanOperation",
|
||||
"canonicalReference": "@essex/boolean-expression-component!BooleanOperation:enum"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"returnTypeTokenRange": {
|
||||
"startIndex": 3,
|
||||
"endIndex": 4
|
||||
},
|
||||
"releaseTag": "Public",
|
||||
"overloadIndex": 1,
|
||||
"parameters": [
|
||||
{
|
||||
"parameterName": "op",
|
||||
"parameterTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
},
|
||||
"isOptional": false
|
||||
}
|
||||
],
|
||||
"name": "toggleOperation"
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/boolean-expression-component!WithChildren:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface WithChildren "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "WithChildren",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/boolean-expression-component!WithChildren#children:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "children?: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "ReactNode",
|
||||
"canonicalReference": "@types/react!~React.ReactNode:type"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "children",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
## API Report File for "@essex/boolean-expression-component"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
/// <reference types="react" />
|
||||
|
||||
import type { CSSProperties } from 'react';
|
||||
import type { ReactNode } from 'react';
|
||||
|
||||
// Warning: (ae-missing-release-tag) "BooleanOperation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export enum BooleanOperation {
|
||||
// (undocumented)
|
||||
AND = "and",
|
||||
// (undocumented)
|
||||
OR = "or"
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "BooleanOperationMap" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface BooleanOperationMap {
|
||||
// (undocumented)
|
||||
__global__: BooleanOperation;
|
||||
// (undocumented)
|
||||
[key: string]: BooleanOperation;
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "BooleanOperationToggle" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const BooleanOperationToggle: React.FC<{
|
||||
className?: string;
|
||||
style?: CSSProperties;
|
||||
operation: BooleanOperation;
|
||||
disabled?: boolean;
|
||||
onToggle?: () => void;
|
||||
palette?: Palette;
|
||||
}>;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "DEFAULT_PALETTE" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const DEFAULT_PALETTE: Palette;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "FilterClause" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface FilterClause {
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
label: string;
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "FilterClauseGroup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface FilterClauseGroup {
|
||||
// (undocumented)
|
||||
filters: FilterClause[];
|
||||
// (undocumented)
|
||||
id: string;
|
||||
// (undocumented)
|
||||
label: string;
|
||||
// (undocumented)
|
||||
locked?: boolean;
|
||||
// (undocumented)
|
||||
operation: BooleanOperation;
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "FilterExpressionView" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const FilterExpressionView: React.FC<{
|
||||
filters: FilterClauseGroup[];
|
||||
operation: BooleanOperation;
|
||||
palette?: Palette;
|
||||
onGlobalOperationChanged?: (data: BooleanOperation) => void;
|
||||
onChipDismissed?: (filter: FilterClause) => void;
|
||||
onOperationChanged?: (id: string, operation: BooleanOperation) => void;
|
||||
onChipGroupDismissed?: (filterGroup: FilterClauseGroup) => void;
|
||||
}>;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "NO_OP" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export const NO_OP: () => void;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "Palette" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface Palette {
|
||||
// (undocumented)
|
||||
backgroundColor: string;
|
||||
// (undocumented)
|
||||
operations: {
|
||||
[BooleanOperation.AND]: string;
|
||||
[BooleanOperation.OR]: string;
|
||||
};
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "toggleOperation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export function toggleOperation(op: BooleanOperation): BooleanOperation;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "WithChildren" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface WithChildren {
|
||||
// (undocumented)
|
||||
children?: ReactNode;
|
||||
}
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md)
|
||||
|
||||
## charts-react package
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [SparkbarProps](./charts-react.sparkbarprops.md) | |
|
||||
| [SparklineProps](./charts-react.sparklineprops.md) | |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [Sparkbar](./charts-react.sparkbar.md) | Renders a basic Sparkbar. This is a Sparkline-style bar chart. |
|
||||
| [Sparkline](./charts-react.sparkline.md) | Renders a basic Sparkline |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [Sparkbar](./charts-react.sparkbar.md)
|
||||
|
||||
## Sparkbar variable
|
||||
|
||||
Renders a basic Sparkbar. This is a Sparkline-style bar chart.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
Sparkbar: React.FC<SparkbarProps>
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [categorical](./charts-react.sparkbarprops.categorical.md)
|
||||
|
||||
## SparkbarProps.categorical property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
categorical?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [color](./charts-react.sparkbarprops.color.md)
|
||||
|
||||
## SparkbarProps.color property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
color?: string | string[];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [data](./charts-react.sparkbarprops.data.md)
|
||||
|
||||
## SparkbarProps.data property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
data: number[];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [height](./charts-react.sparkbarprops.height.md)
|
||||
|
||||
## SparkbarProps.height property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
height: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [legend](./charts-react.sparkbarprops.legend.md)
|
||||
|
||||
## SparkbarProps.legend property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
legend?: string[];
|
||||
```
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md)
|
||||
|
||||
## SparkbarProps interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface SparkbarProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [categorical?](./charts-react.sparkbarprops.categorical.md) | | boolean | <i>(Optional)</i> |
|
||||
| [color?](./charts-react.sparkbarprops.color.md) | | string \| string\[\] | <i>(Optional)</i> |
|
||||
| [data](./charts-react.sparkbarprops.data.md) | | number\[\] | |
|
||||
| [height](./charts-react.sparkbarprops.height.md) | | number | |
|
||||
| [legend?](./charts-react.sparkbarprops.legend.md) | | string\[\] | <i>(Optional)</i> |
|
||||
| [onBarHover?](./charts-react.sparkbarprops.onbarhover.md) | | (event: MouseEvent) => void | <i>(Optional)</i> |
|
||||
| [width](./charts-react.sparkbarprops.width.md) | | number | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [onBarHover](./charts-react.sparkbarprops.onbarhover.md)
|
||||
|
||||
## SparkbarProps.onBarHover property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onBarHover?: (event: MouseEvent) => void;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparkbarProps](./charts-react.sparkbarprops.md) > [width](./charts-react.sparkbarprops.width.md)
|
||||
|
||||
## SparkbarProps.width property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
width: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [Sparkline](./charts-react.sparkline.md)
|
||||
|
||||
## Sparkline variable
|
||||
|
||||
Renders a basic Sparkline
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
Sparkline: React.FC<SparklineProps>
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparklineProps](./charts-react.sparklineprops.md) > [color](./charts-react.sparklineprops.color.md)
|
||||
|
||||
## SparklineProps.color property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
color?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparklineProps](./charts-react.sparklineprops.md) > [data](./charts-react.sparklineprops.data.md)
|
||||
|
||||
## SparklineProps.data property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
data: number[];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparklineProps](./charts-react.sparklineprops.md) > [height](./charts-react.sparklineprops.height.md)
|
||||
|
||||
## SparklineProps.height property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
height: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparklineProps](./charts-react.sparklineprops.md)
|
||||
|
||||
## SparklineProps interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface SparklineProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [color?](./charts-react.sparklineprops.color.md) | | string | <i>(Optional)</i> |
|
||||
| [data](./charts-react.sparklineprops.data.md) | | number\[\] | |
|
||||
| [height](./charts-react.sparklineprops.height.md) | | number | |
|
||||
| [width](./charts-react.sparklineprops.width.md) | | number | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/charts-react](./charts-react.md) > [SparklineProps](./charts-react.sparklineprops.md) > [width](./charts-react.sparklineprops.width.md)
|
||||
|
||||
## SparklineProps.width property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
width: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md)
|
||||
|
||||
## API Reference
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Description |
|
||||
| --- | --- |
|
||||
| [@essex/charts-react](./charts-react.md) | |
|
||||
|
||||
|
|
@ -0,0 +1,590 @@
|
|||
{
|
||||
"metadata": {
|
||||
"toolPackage": "@microsoft/api-extractor",
|
||||
"toolVersion": "7.29.2",
|
||||
"schemaVersion": 1009,
|
||||
"oldestForwardsCompatibleVersion": 1001,
|
||||
"tsdocConfig": {
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
||||
"noStandardTags": true,
|
||||
"tagDefinitions": [
|
||||
{
|
||||
"tagName": "@alpha",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@beta",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@defaultValue",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@decorator",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@deprecated",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@eventProperty",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@example",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@experimental",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@inheritDoc",
|
||||
"syntaxKind": "inline"
|
||||
},
|
||||
{
|
||||
"tagName": "@internal",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@label",
|
||||
"syntaxKind": "inline"
|
||||
},
|
||||
{
|
||||
"tagName": "@link",
|
||||
"syntaxKind": "inline",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@override",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@packageDocumentation",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@param",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@privateRemarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@public",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@readonly",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@remarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@returns",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@sealed",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@see",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@throws",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@typeParam",
|
||||
"syntaxKind": "block",
|
||||
"allowMultiple": true
|
||||
},
|
||||
{
|
||||
"tagName": "@virtual",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@betaDocumentation",
|
||||
"syntaxKind": "modifier"
|
||||
},
|
||||
{
|
||||
"tagName": "@internalRemarks",
|
||||
"syntaxKind": "block"
|
||||
},
|
||||
{
|
||||
"tagName": "@preapproved",
|
||||
"syntaxKind": "modifier"
|
||||
}
|
||||
],
|
||||
"supportForTags": {
|
||||
"@alpha": true,
|
||||
"@beta": true,
|
||||
"@defaultValue": true,
|
||||
"@decorator": true,
|
||||
"@deprecated": true,
|
||||
"@eventProperty": true,
|
||||
"@example": true,
|
||||
"@experimental": true,
|
||||
"@inheritDoc": true,
|
||||
"@internal": true,
|
||||
"@label": true,
|
||||
"@link": true,
|
||||
"@override": true,
|
||||
"@packageDocumentation": true,
|
||||
"@param": true,
|
||||
"@privateRemarks": true,
|
||||
"@public": true,
|
||||
"@readonly": true,
|
||||
"@remarks": true,
|
||||
"@returns": true,
|
||||
"@sealed": true,
|
||||
"@see": true,
|
||||
"@throws": true,
|
||||
"@typeParam": true,
|
||||
"@virtual": true,
|
||||
"@betaDocumentation": true,
|
||||
"@internalRemarks": true,
|
||||
"@preapproved": true
|
||||
},
|
||||
"reportUnsupportedHtmlElements": false
|
||||
}
|
||||
},
|
||||
"kind": "Package",
|
||||
"canonicalReference": "@essex/charts-react!",
|
||||
"docComment": "",
|
||||
"name": "@essex/charts-react",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "EntryPoint",
|
||||
"canonicalReference": "@essex/charts-react!",
|
||||
"name": "",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/charts-react!Sparkbar:var",
|
||||
"docComment": "/**\n * Renders a basic Sparkbar. This is a Sparkline-style bar chart.\n */\n",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "Sparkbar: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "React.FC",
|
||||
"canonicalReference": "@types/react!~React.FC:type"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "<"
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "SparkbarProps",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ">"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "Sparkbar",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 5
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface SparkbarProps "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "SparkbarProps",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#categorical:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "categorical?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "boolean"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "categorical",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#color:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "color?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string | string[]"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "color",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#data:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "data: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number[]"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "data",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#height:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "height: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "height",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#legend:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "legend?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string[]"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "legend",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#onBarHover:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "onBarHover?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "(event: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "MouseEvent",
|
||||
"canonicalReference": "!MouseEvent:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ") => void"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "onBarHover",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 4
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparkbarProps#width:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "width: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "width",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
},
|
||||
{
|
||||
"kind": "Variable",
|
||||
"canonicalReference": "@essex/charts-react!Sparkline:var",
|
||||
"docComment": "/**\n * Renders a basic Sparkline\n */\n",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "Sparkline: "
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "React.FC",
|
||||
"canonicalReference": "@types/react!~React.FC:type"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "<"
|
||||
},
|
||||
{
|
||||
"kind": "Reference",
|
||||
"text": "SparklineProps",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps:interface"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ">"
|
||||
}
|
||||
],
|
||||
"isReadonly": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "Sparkline",
|
||||
"variableTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 5
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "Interface",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps:interface",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "export interface SparklineProps "
|
||||
}
|
||||
],
|
||||
"releaseTag": "Public",
|
||||
"name": "SparklineProps",
|
||||
"preserveMemberOrder": false,
|
||||
"members": [
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps#color:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "color?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "string"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "color",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps#data:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "data: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number[]"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "data",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps#height:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "height: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "height",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@essex/charts-react!SparklineProps#width:member",
|
||||
"docComment": "",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "width: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": false,
|
||||
"releaseTag": "Public",
|
||||
"name": "width",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
}
|
||||
],
|
||||
"extendsTokenRanges": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
## API Report File for "@essex/charts-react"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
/// <reference types="react" />
|
||||
|
||||
// Warning: (ae-missing-release-tag) "Sparkbar" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public
|
||||
export const Sparkbar: React.FC<SparkbarProps>;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "SparkbarProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface SparkbarProps {
|
||||
// (undocumented)
|
||||
categorical?: boolean;
|
||||
// (undocumented)
|
||||
color?: string | string[];
|
||||
// (undocumented)
|
||||
data: number[];
|
||||
// (undocumented)
|
||||
height: number;
|
||||
// (undocumented)
|
||||
legend?: string[];
|
||||
// (undocumented)
|
||||
onBarHover?: (event: MouseEvent) => void;
|
||||
// (undocumented)
|
||||
width: number;
|
||||
}
|
||||
|
||||
// Warning: (ae-missing-release-tag) "Sparkline" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public
|
||||
export const Sparkline: React.FC<SparklineProps>;
|
||||
|
||||
// Warning: (ae-missing-release-tag) "SparklineProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
|
||||
//
|
||||
// @public (undocumented)
|
||||
export interface SparklineProps {
|
||||
// (undocumented)
|
||||
color?: string;
|
||||
// (undocumented)
|
||||
data: number[];
|
||||
// (undocumented)
|
||||
height: number;
|
||||
// (undocumented)
|
||||
width: number;
|
||||
}
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ButtonChoiceGroup](./components.buttonchoicegroup.md)
|
||||
|
||||
## ButtonChoiceGroup variable
|
||||
|
||||
ButtonChoiceGroup is a ChoiceGroup component that renders as buttons instead of radios.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ButtonChoiceGroup: React.FC<IChoiceGroupProps>
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraph](./components.clippedgraph.md)
|
||||
|
||||
## ClippedGraph variable
|
||||
|
||||
Creates a line chart that handles extreme distributions with a few clipping/wrapping strategies. The "clipped graph" concept was presented by Haihan Lin at VIS2019. https://vdl.sci.utah.edu/publications/2019\_infovis\_clipped\_graphs/ This chart can also produce a horizon plot, or be formatted to look like a sparkline. For examples of these variants, see the visual sandbox: https://visualsandbox.azurewebsites.net/\#/experiments/clipped-graphs
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ClippedGraph: ({ data, width, height, clipped, percentile, gradient, gradientInterpolation, gradientBand, horizon, sparkline, }: ClippedGraphProps) => JSX.Element
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [clipped](./components.clippedgraphprops.clipped.md)
|
||||
|
||||
## ClippedGraphProps.clipped property
|
||||
|
||||
Indicates that the y axis should be clipped due to extreme values. 90th percentile will be plotted.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
clipped?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [data](./components.clippedgraphprops.data.md)
|
||||
|
||||
## ClippedGraphProps.data property
|
||||
|
||||
List of values to plot. Currently this is the y axis, the x axis is ordinal. TODO: support more complex data types such as x/y points or explicit time series.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
data: number[];
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [gradient](./components.clippedgraphprops.gradient.md)
|
||||
|
||||
## ClippedGraphProps.gradient property
|
||||
|
||||
Indicates if a gradient fill should be used under the line to add redundant data encoding.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
gradient?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [gradientBand](./components.clippedgraphprops.gradientband.md)
|
||||
|
||||
## ClippedGraphProps.gradientBand property
|
||||
|
||||
Indicates if the gradient should just be a band along the top instead of filling under the line. If supplied, this should be a height for the band in pixels.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
gradientBand?: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [gradientInterpolation](./components.clippedgraphprops.gradientinterpolation.md)
|
||||
|
||||
## ClippedGraphProps.gradientInterpolation property
|
||||
|
||||
This is a multiplier to use for interpolating gradient values between data values. If your data is not very dense, the gradient fill will look very blocky. Defaults to 4.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
gradientInterpolation?: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [height](./components.clippedgraphprops.height.md)
|
||||
|
||||
## ClippedGraphProps.height property
|
||||
|
||||
Height of the chart in pixels.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
height: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [horizon](./components.clippedgraphprops.horizon.md)
|
||||
|
||||
## ClippedGraphProps.horizon property
|
||||
|
||||
Indicates to create a horizon plot instead, by 'wrapping' the top 10% data values around the y axis.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
horizon?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md)
|
||||
|
||||
## ClippedGraphProps interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ClippedGraphProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [clipped?](./components.clippedgraphprops.clipped.md) | | boolean | <i>(Optional)</i> Indicates that the y axis should be clipped due to extreme values. 90th percentile will be plotted. |
|
||||
| [data](./components.clippedgraphprops.data.md) | | number\[\] | List of values to plot. Currently this is the y axis, the x axis is ordinal. TODO: support more complex data types such as x/y points or explicit time series. |
|
||||
| [gradient?](./components.clippedgraphprops.gradient.md) | | boolean | <i>(Optional)</i> Indicates if a gradient fill should be used under the line to add redundant data encoding. |
|
||||
| [gradientBand?](./components.clippedgraphprops.gradientband.md) | | number | <i>(Optional)</i> Indicates if the gradient should just be a band along the top instead of filling under the line. If supplied, this should be a height for the band in pixels. |
|
||||
| [gradientInterpolation?](./components.clippedgraphprops.gradientinterpolation.md) | | number | <i>(Optional)</i> This is a multiplier to use for interpolating gradient values between data values. If your data is not very dense, the gradient fill will look very blocky. Defaults to 4. |
|
||||
| [height](./components.clippedgraphprops.height.md) | | number | Height of the chart in pixels. |
|
||||
| [horizon?](./components.clippedgraphprops.horizon.md) | | boolean | <i>(Optional)</i> Indicates to create a horizon plot instead, by 'wrapping' the top 10% data values around the y axis. |
|
||||
| [percentile?](./components.clippedgraphprops.percentile.md) | | number | <i>(Optional)</i> Percentile of the data to plot on the main graph. The remainder will be plotted as overflow. |
|
||||
| [sparkline?](./components.clippedgraphprops.sparkline.md) | | boolean | <i>(Optional)</i> Render this as a sparkline, i.e., much thinner and lighter. |
|
||||
| [width](./components.clippedgraphprops.width.md) | | number | Width of the chart in pixels. |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [percentile](./components.clippedgraphprops.percentile.md)
|
||||
|
||||
## ClippedGraphProps.percentile property
|
||||
|
||||
Percentile of the data to plot on the main graph. The remainder will be plotted as overflow.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
percentile?: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [sparkline](./components.clippedgraphprops.sparkline.md)
|
||||
|
||||
## ClippedGraphProps.sparkline property
|
||||
|
||||
Render this as a sparkline, i.e., much thinner and lighter.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sparkline?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ClippedGraphProps](./components.clippedgraphprops.md) > [width](./components.clippedgraphprops.width.md)
|
||||
|
||||
## ClippedGraphProps.width property
|
||||
|
||||
Width of the chart in pixels.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
width: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanel](./components.collapsiblepanel.md)
|
||||
|
||||
## CollapsiblePanel variable
|
||||
|
||||
CollapsiblePanel displays a Header and its child that collapse and expands with keyboard arrows, space, enter or onclick showing the 'hidden' rendering
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
CollapsiblePanel: React.FC<PropsWithChildren<CollapsiblePanelProps>>
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelContainer](./components.collapsiblepanelcontainer.md)
|
||||
|
||||
## CollapsiblePanelContainer variable
|
||||
|
||||
Receives an array of CollapsiblePanel as children to render it with first and last props calculating it automatically
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
CollapsiblePanelContainer: React.FC<PropsWithChildren<CollapsiblePanelContainerProps>>
|
||||
```
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelContainerProps](./components.collapsiblepanelcontainerprops.md)
|
||||
|
||||
## CollapsiblePanelContainerProps interface
|
||||
|
||||
The container that will have multiple CollapsiblePanel as children, passing the last and first params automatically.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface CollapsiblePanelContainerProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [styles?](./components.collapsiblepanelcontainerprops.styles.md) | | { root?: CSSProperties; } | <i>(Optional)</i> |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelContainerProps](./components.collapsiblepanelcontainerprops.md) > [styles](./components.collapsiblepanelcontainerprops.styles.md)
|
||||
|
||||
## CollapsiblePanelContainerProps.styles property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
styles?: {
|
||||
root?: CSSProperties;
|
||||
};
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [buttonProps](./components.collapsiblepanelprops.buttonprops.md)
|
||||
|
||||
## CollapsiblePanelProps.buttonProps property
|
||||
|
||||
Custom props for the expand/collapse icon button.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
buttonProps?: IButtonProps;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [defaultExpanded](./components.collapsiblepanelprops.defaultexpanded.md)
|
||||
|
||||
## CollapsiblePanelProps.defaultExpanded property
|
||||
|
||||
If true the initial state will be expanded
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
defaultExpanded?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [duration](./components.collapsiblepanelprops.duration.md)
|
||||
|
||||
## CollapsiblePanelProps.duration property
|
||||
|
||||
Duration of the expand/collapse content animation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
duration?: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [expanded](./components.collapsiblepanelprops.expanded.md)
|
||||
|
||||
## CollapsiblePanelProps.expanded property
|
||||
|
||||
Optional boolean to control the state outside this component
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
expanded?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [first](./components.collapsiblepanelprops.first.md)
|
||||
|
||||
## CollapsiblePanelProps.first property
|
||||
|
||||
If it's the first element of the panel it applies a different style
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
first?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [hideIcon](./components.collapsiblepanelprops.hideicon.md)
|
||||
|
||||
## CollapsiblePanelProps.hideIcon property
|
||||
|
||||
Hide the expand/collapse icon entirely. It is visible by default.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hideIcon?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [last](./components.collapsiblepanelprops.last.md)
|
||||
|
||||
## CollapsiblePanelProps.last property
|
||||
|
||||
If it's the last element of the panel it applies a different style
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
last?: boolean;
|
||||
```
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md)
|
||||
|
||||
## CollapsiblePanelProps interface
|
||||
|
||||
Props for the CollapsiblePanel
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface CollapsiblePanelProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [buttonProps?](./components.collapsiblepanelprops.buttonprops.md) | | IButtonProps | <i>(Optional)</i> Custom props for the expand/collapse icon button. |
|
||||
| [defaultExpanded?](./components.collapsiblepanelprops.defaultexpanded.md) | | boolean | <i>(Optional)</i> If true the initial state will be expanded |
|
||||
| [duration?](./components.collapsiblepanelprops.duration.md) | | number | <i>(Optional)</i> Duration of the expand/collapse content animation. |
|
||||
| [expanded?](./components.collapsiblepanelprops.expanded.md) | | boolean | <i>(Optional)</i> Optional boolean to control the state outside this component |
|
||||
| [first?](./components.collapsiblepanelprops.first.md) | | boolean | <i>(Optional)</i> If it's the first element of the panel it applies a different style |
|
||||
| [hideIcon?](./components.collapsiblepanelprops.hideicon.md) | | boolean | <i>(Optional)</i> Hide the expand/collapse icon entirely. It is visible by default. |
|
||||
| [last?](./components.collapsiblepanelprops.last.md) | | boolean | <i>(Optional)</i> If it's the last element of the panel it applies a different style |
|
||||
| [onHeaderClick?](./components.collapsiblepanelprops.onheaderclick.md) | | () => void | <i>(Optional)</i> Optional function to respond to clicks in the general header area. |
|
||||
| [onIconClick?](./components.collapsiblepanelprops.oniconclick.md) | | () => void | <i>(Optional)</i> Optional function to respond to clicks on the expand/collapse icon directly. |
|
||||
| [onRenderHeader?](./components.collapsiblepanelprops.onrenderheader.md) | | IRenderFunction<any> | <i>(Optional)</i> Optional function to render a different header than the default. Note that if you supply a custom header renderer with interactive controls, you may need to call e.stopPropagation in their click handlers to prevent unwanted expand/collapse behavior. |
|
||||
| [styles?](./components.collapsiblepanelprops.styles.md) | | [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) | <i>(Optional)</i> Custom styles for the subcomponents |
|
||||
| [title?](./components.collapsiblepanelprops.title.md) | | string | <i>(Optional)</i> Title for the panel |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [onHeaderClick](./components.collapsiblepanelprops.onheaderclick.md)
|
||||
|
||||
## CollapsiblePanelProps.onHeaderClick property
|
||||
|
||||
Optional function to respond to clicks in the general header area.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onHeaderClick?: () => void;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [onIconClick](./components.collapsiblepanelprops.oniconclick.md)
|
||||
|
||||
## CollapsiblePanelProps.onIconClick property
|
||||
|
||||
Optional function to respond to clicks on the expand/collapse icon directly.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onIconClick?: () => void;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [onRenderHeader](./components.collapsiblepanelprops.onrenderheader.md)
|
||||
|
||||
## CollapsiblePanelProps.onRenderHeader property
|
||||
|
||||
Optional function to render a different header than the default. Note that if you supply a custom header renderer with interactive controls, you may need to call e.stopPropagation in their click handlers to prevent unwanted expand/collapse behavior.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onRenderHeader?: IRenderFunction<any>;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [styles](./components.collapsiblepanelprops.styles.md)
|
||||
|
||||
## CollapsiblePanelProps.styles property
|
||||
|
||||
Custom styles for the subcomponents
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
styles?: CollapsiblePanelStyles;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelProps](./components.collapsiblepanelprops.md) > [title](./components.collapsiblepanelprops.title.md)
|
||||
|
||||
## CollapsiblePanelProps.title property
|
||||
|
||||
Title for the panel
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
title?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) > [content](./components.collapsiblepanelstyles.content.md)
|
||||
|
||||
## CollapsiblePanelStyles.content property
|
||||
|
||||
Style for the content container
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
content?: CSSProperties;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) > [header](./components.collapsiblepanelstyles.header.md)
|
||||
|
||||
## CollapsiblePanelStyles.header property
|
||||
|
||||
Style for the outer header container
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
header?: CSSProperties;
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md)
|
||||
|
||||
## CollapsiblePanelStyles interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface CollapsiblePanelStyles
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [content?](./components.collapsiblepanelstyles.content.md) | | CSSProperties | <i>(Optional)</i> Style for the content container |
|
||||
| [header?](./components.collapsiblepanelstyles.header.md) | | CSSProperties | <i>(Optional)</i> Style for the outer header container |
|
||||
| [root?](./components.collapsiblepanelstyles.root.md) | | CSSProperties | <i>(Optional)</i> Style for outer component container |
|
||||
| [title?](./components.collapsiblepanelstyles.title.md) | | CSSProperties | <i>(Optional)</i> Style for the header title text |
|
||||
| [titleContainer?](./components.collapsiblepanelstyles.titlecontainer.md) | | CSSProperties | <i>(Optional)</i> Container box around the title text |
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) > [root](./components.collapsiblepanelstyles.root.md)
|
||||
|
||||
## CollapsiblePanelStyles.root property
|
||||
|
||||
Style for outer component container
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
root?: CSSProperties;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) > [title](./components.collapsiblepanelstyles.title.md)
|
||||
|
||||
## CollapsiblePanelStyles.title property
|
||||
|
||||
Style for the header title text
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
title?: CSSProperties;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CollapsiblePanelStyles](./components.collapsiblepanelstyles.md) > [titleContainer](./components.collapsiblepanelstyles.titlecontainer.md)
|
||||
|
||||
## CollapsiblePanelStyles.titleContainer property
|
||||
|
||||
Container box around the title text
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
titleContainer?: CSSProperties;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenu](./components.columnarmenu.md)
|
||||
|
||||
## ColumnarMenu variable
|
||||
|
||||
Dropdown button menu that supports grouped items (using sectionProps) in a columnar layout. This is a hybrid control that uses a button to create the dropdown menu, but overrides the menu renderer to lay out any item sections as columns instead of a vertical stack.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ColumnarMenu: React.FC<ColumnarMenuProps>
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenuList](./components.columnarmenulist.md)
|
||||
|
||||
## ColumnarMenuList variable
|
||||
|
||||
This component replaces the default ContextualMenuList rendering with a columnar layout of the sections instead of vertical stacks. Note that items should be sorted into sections with sectionProps, though options buttons do not need to be in a section and will all be coalesced at the top.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ColumnarMenuList: React.FC<ColumnarMenuListProps>
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenuProps](./components.columnarmenuprops.md) > [buttonProps](./components.columnarmenuprops.buttonprops.md)
|
||||
|
||||
## ColumnarMenuProps.buttonProps property
|
||||
|
||||
Props to customize the menu button
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
buttonProps?: IButtonProps;
|
||||
```
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenuProps](./components.columnarmenuprops.md)
|
||||
|
||||
## ColumnarMenuProps interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ColumnarMenuProps extends IContextualMenuProps
|
||||
```
|
||||
<b>Extends:</b> IContextualMenuProps
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [buttonProps?](./components.columnarmenuprops.buttonprops.md) | | IButtonProps | <i>(Optional)</i> Props to customize the menu button |
|
||||
| [menuListProps?](./components.columnarmenuprops.menulistprops.md) | | Partial<ColumnarMenuListProps> | <i>(Optional)</i> |
|
||||
| [text?](./components.columnarmenuprops.text.md) | | string | <i>(Optional)</i> Text to display in the menu button |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenuProps](./components.columnarmenuprops.md) > [menuListProps](./components.columnarmenuprops.menulistprops.md)
|
||||
|
||||
## ColumnarMenuProps.menuListProps property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
menuListProps?: Partial<ColumnarMenuListProps>;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ColumnarMenuProps](./components.columnarmenuprops.md) > [text](./components.columnarmenuprops.text.md)
|
||||
|
||||
## ColumnarMenuProps.text property
|
||||
|
||||
Text to display in the menu button
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
text?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilter](./components.controlledhistogramfilter.md)
|
||||
|
||||
## ControlledHistogramFilter variable
|
||||
|
||||
ControlledHistogramFilter displays a histogram that contains a D3 brush and basic numberical filtering with thematic theming
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ControlledHistogramFilter: ({ name, data, width, height, selectedRange, onChange, selectedFill, unselectedFill, }: ControlledHistogramFilterProps) => JSX.Element
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [data](./components.controlledhistogramfilterprops.data.md)
|
||||
|
||||
## ControlledHistogramFilterProps.data property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
data: number[];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [height](./components.controlledhistogramfilterprops.height.md)
|
||||
|
||||
## ControlledHistogramFilterProps.height property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
height: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md)
|
||||
|
||||
## ControlledHistogramFilterProps interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ControlledHistogramFilterProps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [data](./components.controlledhistogramfilterprops.data.md) | | number\[\] | |
|
||||
| [height](./components.controlledhistogramfilterprops.height.md) | | number | |
|
||||
| [name](./components.controlledhistogramfilterprops.name.md) | | string | |
|
||||
| [onChange?](./components.controlledhistogramfilterprops.onchange.md) | | (range: \[number \| undefined, number \| undefined\]) => any | <i>(Optional)</i> |
|
||||
| [selectedFill?](./components.controlledhistogramfilterprops.selectedfill.md) | | string | <i>(Optional)</i> |
|
||||
| [selectedRange](./components.controlledhistogramfilterprops.selectedrange.md) | | \[number \| undefined, number \| undefined\] | |
|
||||
| [unselectedFill?](./components.controlledhistogramfilterprops.unselectedfill.md) | | string | <i>(Optional)</i> |
|
||||
| [width](./components.controlledhistogramfilterprops.width.md) | | number | |
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [name](./components.controlledhistogramfilterprops.name.md)
|
||||
|
||||
## ControlledHistogramFilterProps.name property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [onChange](./components.controlledhistogramfilterprops.onchange.md)
|
||||
|
||||
## ControlledHistogramFilterProps.onChange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
onChange?: (range: [number | undefined, number | undefined]) => any;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [selectedFill](./components.controlledhistogramfilterprops.selectedfill.md)
|
||||
|
||||
## ControlledHistogramFilterProps.selectedFill property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
selectedFill?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [selectedRange](./components.controlledhistogramfilterprops.selectedrange.md)
|
||||
|
||||
## ControlledHistogramFilterProps.selectedRange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
selectedRange: [number | undefined, number | undefined];
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [unselectedFill](./components.controlledhistogramfilterprops.unselectedfill.md)
|
||||
|
||||
## ControlledHistogramFilterProps.unselectedFill property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
unselectedFill?: string;
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [ControlledHistogramFilterProps](./components.controlledhistogramfilterprops.md) > [width](./components.controlledhistogramfilterprops.width.md)
|
||||
|
||||
## ControlledHistogramFilterProps.width property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
width: number;
|
||||
```
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CookieConsent](./components.cookieconsent.md)
|
||||
|
||||
## CookieConsent type
|
||||
|
||||
Record of approved and blocked cookie types.
|
||||
|
||||
Record<!-- --><<!-- -->"Required" \| "Analytics" \| "SocialMedia" \| "Advertising", boolean<!-- -->>
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type CookieConsent = Record<CookieConsentCategories, boolean>;
|
||||
```
|
||||
<b>References:</b> [CookieConsentCategories](./components.cookieconsentcategories.md)
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CookieConsentBannerThemes](./components.cookieconsentbannerthemes.md)
|
||||
|
||||
## CookieConsentBannerThemes type
|
||||
|
||||
Theme of the cookie consent banner popup that is managed by the wcp script. This sets the theme for the popup only and does not impact the theme of the policy footer or links. The policy footer uses FluentUI so it should pick up the theme from parent FluentUI theme provider.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type CookieConsentBannerThemes = 'light' | 'dark' | 'high-contrast';
|
||||
```
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@essex/components](./components.md) > [CookieConsentCategories](./components.cookieconsentcategories.md)
|
||||
|
||||
## CookieConsentCategories enum
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum CookieConsentCategories
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Advertising | <code>"Advertising"</code> | Cookies to record which ads are already seen, clicked, or purchased |
|
||||
| Analytics | <code>"Analytics"</code> | Cookies to understand how website is used, may be also used on 3rd party websites that are not owned or operated by Microsoft |
|
||||
| Required | <code>"Required"</code> | Cookies to perform essential website functions (sign-in, language settings,...) |
|
||||
| SocialMedia | <code>"SocialMedia"</code> | Cookies to show ads and content based on user social media profiles and activity on Microsoft websites |
|
||||
|
||||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче