@malloydata/render 0.0.399 → 0.0.401
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/module/data_tree/utils.d.ts +1 -1
- package/dist/module/index.mjs +103758 -31681
- package/dist/module/index.umd.js +1405 -83
- package/dist/module/util.d.ts +0 -2
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Malloy Renderer
|
|
2
2
|
|
|
3
|
-
The Malloy Renderer is a web component for rendering Malloy query results. It is included by default in the Malloy VSCode extension, but can also be embedded by developers into their own applications
|
|
3
|
+
The Malloy Renderer is a web component for rendering Malloy query results. It is included by default in the Malloy VSCode extension, but can also be embedded by developers into their own applications. To learn more about how to use the renderer in a Malloy model, see [the Renderer docs](https://docs.malloydata.dev/documentation/visualizations/overview).
|
|
4
4
|
|
|
5
5
|
## Using the Renderer in Web Apps
|
|
6
6
|
|
|
@@ -25,7 +25,7 @@ malloyRenderElement.result = myMalloyResult;
|
|
|
25
25
|
|
|
26
26
|
/*
|
|
27
27
|
Alternatively, you can pass Malloy QueryResult and ModelDef objects to the renderer,
|
|
28
|
-
which will then construct the Result object. This is useful when you are receiving
|
|
28
|
+
which will then construct the Result object. This is useful when you are receiving serialized Malloy results via an API.
|
|
29
29
|
*/
|
|
30
30
|
malloyRenderElement.queryResult = myQueryResult;
|
|
31
31
|
malloyRenderElement.modelDef = myModelDef;
|
|
@@ -17,7 +17,7 @@ export declare function shouldRenderAs({ field, tagOverride, }: {
|
|
|
17
17
|
field: FieldBase;
|
|
18
18
|
tagOverride?: Tag;
|
|
19
19
|
}): string;
|
|
20
|
-
export declare function tagFor(field: Malloy.DimensionInfo,
|
|
20
|
+
export declare function tagFor(field: Malloy.DimensionInfo, route?: string): Tag;
|
|
21
21
|
export declare function extractExpressionFromTag(tag: Tag): Malloy.Expression | undefined;
|
|
22
22
|
export declare function extractLiteralFromTag(tag: Tag): Malloy.LiteralValue | undefined;
|
|
23
23
|
export declare function getFieldType(field: Field): FieldType;
|