@kanaries/graphic-walker 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,16 @@
+Graphic Waller is an embeded interaction EDA tool.
+
+Copyright (C) 2019-now Observed Observer(Hao Chen)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

package/README.md

@@ -9,15 +9,19 @@ Main features:
 + A Data Explainer which explain some why some patterns occur / what may cause them.
 
 ## Usage
+
+### use as an embedding module
 ```bash
-cd graphic-waler
-yarn install
-npm run build
+yarn add @kanaries/graphic-walker
+
+# or
+
+npm i --save @kanaries/graphic-walker
 ```
 
 In your app:
 ```typescript
-import { GraphicWalker } from 'graphic-walker';
+import { GraphicWalker } from '@kanaries/graphic-walker';
 import 'graphic-walker/dist/style.css'
 
 const YourEmbeddingTableauStyleApp: React.FC = props => {
@@ -30,4 +34,10 @@ const YourEmbeddingTableauStyleApp: React.FC = props => {
 }
 
 export default YourEmbeddingTableauStyleApp;
-```
+```
+
+### try local
+```bash
+# packages/graphic-walker
+npm run dev
+```

package/dist/App.d.ts

@@ -2,9 +2,11 @@ import React from 'react';
 import { Record, IMutField } from './interfaces';
 import "tailwindcss/tailwind.css";
 import './index.css';
+import { Specification } from 'visual-insights';
 export interface EditorProps {
     dataSource?: Record[];
     rawFields?: IMutField[];
+    spec?: Specification;
 }
 declare const _default: React.FunctionComponent<EditorProps>;
 export default _default;

package/dist/Fields/datasetFields/dimFields.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { DroppableProvided } from 'react-beautiful-dnd';
+interface Props {
+    provided: DroppableProvided;
+}
+declare const _default: React.FunctionComponent<Props>;
+export default _default;

package/dist/Fields/datasetFields/meaFields.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { DroppableProvided } from 'react-beautiful-dnd';
+interface Props {
+    provided: DroppableProvided;
+}
+declare const _default: React.FunctionComponent<Props>;
+export default _default;

package/dist/Fields/fieldsContext.d.ts

@@ -1,20 +1,8 @@
 import React from 'react';
-import { Field } from '../interfaces';
-export interface DraggableFieldState {
-    fields: Field[];
-    rows: Field[];
-    columns: Field[];
-    color: Field[];
-    opacity: Field[];
-    size: Field[];
-}
+import { IDraggableStateKey } from '../interfaces';
 export declare const FieldsContextWrapper: React.FC;
 export default FieldsContextWrapper;
-export declare const DRAGGABLE_STATE_KEYS: Array<{
-    id: keyof DraggableFieldState;
-    name: string;
-    mode: number;
-}>;
+export declare const DRAGGABLE_STATE_KEYS: Array<IDraggableStateKey>;
 export declare const AGGREGATOR_LIST: {
     value: string;
     label: string;

package/dist/Fields/obComponents/obFContainer.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { DroppableProvided } from "react-beautiful-dnd";
+import { IDraggableStateKey } from '../../interfaces';
+interface FieldContainerProps {
+    provided: DroppableProvided;
+    /**
+     * draggable Field Id
+     */
+    dkey: IDraggableStateKey;
+}
+declare const _default: React.FunctionComponent<FieldContainerProps>;
+export default _default;

package/dist/Fields/obComponents/obPill.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { DraggableProvided } from 'react-beautiful-dnd';
+import { IDraggableStateKey } from '../../interfaces';
+interface PillProps {
+    provided: DraggableProvided;
+    fIndex: number;
+    dkey: IDraggableStateKey;
+}
+declare const _default: React.FunctionComponent<PillProps>;
+export default _default;

package/dist/Fields/posFields/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const PosFields: React.FC;
+export default PosFields;