@jpmorganchase/anu / Exports
@jpmorganchase/anu
Table of contents
Classes
Variables
Functions
- bind
- create
- createAxes
- createMeshMap
- createPlaneText
- createTextureGlobe
- createTextureMap
- cylinderLayout
- ordinalChromatic
- planeLayout
- select
- selectData
- selectId
- selectName
- selectTag
- sequentialChromatic
Variables
schemes
• schemes: StringByAny
Defined in
prefabs/Chromatic/Chromatic.ts:81
Functions
bind
▸ bind<MeshType>(shape, options?, data?, scene?): Selection
Take a shape type, a scene, and data. For each index in the data create a new mesh for each node in the selection as the parent. The data index of the mesh is also attached to the mesh node object under the metadata property.
Type parameters
| Name | Type |
|---|---|
MeshType | extends keyof MeshTypes |
Parameters
| Name | Type | Description |
|---|---|---|
shape | MeshType | A string of the type of the mesh geometry being created. |
options? | Property<MeshTypes, MeshType> | A object containing the initial mesh parameters for the selected geometry, can be either values or functions. |
data | object[] | The data to bind elements too, must be passed as a list of objects where each object represents a row of tabular data. |
scene? | Scene | The Babylon scene you are targeting. |
Returns
An instance of Selection, a class containing a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
create
▸ create<MeshType>(shape, name, options?, data?, scene?): Mesh
Helper function to build meshes of a specified type with options optionally set with functions and data.
Type parameters
| Name | Type |
|---|---|
MeshType | extends keyof MeshTypes |
Parameters
| Name | Type | Description |
|---|---|---|
shape | MeshType | The name of the mesh type you want to create. |
name | string | The string that will be used as the inital mesh ID and name. |
options | Property<MeshTypes, MeshType> | An object containg the mesh parametetrs as either absolutle values or functions. |
data | object | An object containg the data that may be used to execute any functions passed in options. |
scene? | Scene | The scene to create the mesh in. |
Returns
Mesh
A mesh object created with the passed parameters.
Defined in
createAxes
▸ createAxes(name, scene, options): Axis
Parameters
| Name | Type |
|---|---|
name | string |
scene | Scene |
options | AxisOptions |
Returns
Defined in
createMeshMap
▸ createMeshMap(name, options, scene?): MeshMap
Parameters
| Name | Type |
|---|---|
name | string |
options | Object |
options.cot? | Node | Mesh | TransformNode |
options.depth? | number |
options.geoJson | GeoGeometryObjects |
options.projection? | GeoProjection |
options.simplification? | number |
options.size? | [number, number] |
options.transform? | [number, number] |
scene? | Scene |
Returns
Defined in
createPlaneText
▸ createPlaneText(name, options, scene): Mesh
Parameters
| Name | Type |
|---|---|
name | string |
options | planeTextOptions |
scene | Scene |
Returns
Mesh
Defined in
createTextureGlobe
▸ createTextureGlobe(name, options?, scene?): TextureGlobe
Parameters
| Name | Type |
|---|---|
name | string |
options | Object |
options.diameter? | number |
options.layers? | TileLayer<any>[] |
options.resolution? | Vector2 |
options.view? | View |
scene? | Scene |
Returns
Defined in
prefabs/Mapping/textureGlobe.ts:123
createTextureMap
▸ createTextureMap(name, options?, scene?): TextureMap
Parameters
| Name | Type |
|---|---|
name | string |
options | Object |
options.layers? | TileLayer<any>[] |
options.mapHeight? | number |
options.mapWidth? | number |
options.meshSize? | number |
options.view? | View |
scene? | Scene |
Returns
Defined in
prefabs/Mapping/textureMap.ts:191
cylinderLayout
▸ cylinderLayout(name, options, scene): Layout
Parameters
| Name | Type |
|---|---|
name | string |
options | LayoutOptions |
scene | Scene |
Returns
Defined in
ordinalChromatic
▸ ordinalChromatic(scheme): OrdinalChromatic
Parameters
| Name | Type |
|---|---|
scheme | string | string[] |
Returns
Defined in
prefabs/Chromatic/Chromatic.ts:68
planeLayout
▸ planeLayout(name, options, scene): Layout
Parameters
| Name | Type |
|---|---|
name | string |
options | LayoutOptions |
scene | Scene |
Returns
Defined in
select
▸ select(name, scene): Selection
Select all nodes from the scene graph matching the indicator and return them as a instance of Selection.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The prefix and text of the selection, selection types include: .<name>, #<id>, $<tags>. |
scene | Scene | The babylon scene the to select from. |
Returns
an instance of Selection, a class contating a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
selectData
▸ selectData(key, value, scene): Selection
Select all nodes from the scene graph with binded data matching the given key value pairs and return them as a instance of Selection.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | string[] | the key or list of keys of the nodes to be selected. |
value | string | number | string[] | number[] | the value or list of values corresponding to the respective key(s) passed. |
scene | Scene | The babylon scene the to select from. |
Returns
an instance of Selection, a class contating a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
selectId
▸ selectId(id, scene): Selection
Select all nodes from the scene graph matching the given ID(s) and return them as a instance of Selection.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | string[] | the ID or list of IDs of the nodes to be selected |
scene | Scene | The babylon scene the to select from. |
Returns
an instance of Selection, a class contating a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
selectName
▸ selectName(name, scene): Selection
Select all nodes from the scene graph matching the given name(s) and return them as a instance of Selection.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | string[] | the name or list of names of the nodes to be selected |
scene | Scene | The babylon scene the to select from. |
Returns
an instance of Selection, a class contating a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
selectTag
▸ selectTag(tag, scene): Selection
Select all nodes from the scene graph matching the given tag(s) and return them as a instance of Selection.
Parameters
| Name | Type | Description |
|---|---|---|
tag | string | string[] | the tag and tag logic or list of tags of the nodes to be selected |
scene | Scene | The babylon scene the to select from. |
Returns
an instance of Selection, a class contating a array of selected nodes, the scene, and the functions of the class Selection, or undefined if a selection could not be made.
Defined in
sequentialChromatic
▸ sequentialChromatic(scheme): SequentialChromatic
Parameters
| Name | Type |
|---|---|
scheme | string |