Mapper
- Kind
- class
- Source
- src/pipeline/Mapper.js:842
Description
Low-level mapper for one node or edge visual mode.
Signature
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options | Object | optional | Mapper mode (node or edge), network, and optional bookkeeping dependencies. |
Returns
Mapper with an initially empty channel set.
TypeMapperNotes
Most applications should use MapperCollection or
MappersBehavior. Direct mapper access is still public for custom pipelines
that need to build visual attributes programmatically.
Configuration
General configuration setters and compatibility helpers.
setChannel(name, config) → {this}
Source: src/pipeline/Mapper.js:854
Set the channel setting.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name | string | Attribute or API identifier. | ||
config | Value passed to setChannel. |
Returns
This instance.
TypethisgetChannel(name)
Source: src/pipeline/Mapper.js:866
Returns the current channel value or state.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name | string | Attribute or API identifier. |
Utilities
Additional public helpers that do not belong to a narrower API area.
channel(name)
Source: src/pipeline/Mapper.js:850
Configures or reads channel.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name | string | Attribute or API identifier. |
mapItem(item, context = {})
Source: src/pipeline/Mapper.js:870
Configures or reads map item.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
item | Value passed to mapItem. | |||
context | optional | {} | Value passed to mapItem. |
mapItems(items, context = {})
Source: src/pipeline/Mapper.js:879
Configures or reads map items.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
items | Value passed to mapItems. | |||
context | optional | {} | Value passed to mapItems. |
ensurePercentileLookup(config)
Source: src/pipeline/Mapper.js:883
Configures or reads ensure percentile lookup.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to ensurePercentileLookup. |
ensureBuffersForChannel(config)
Source: src/pipeline/Mapper.js:892
Configures or reads ensure buffers for channel.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to ensureBuffersForChannel. |
shouldEnsureChannelBuffer(config, def)
Source: src/pipeline/Mapper.js:943
Configures or reads should ensure channel buffer.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to shouldEnsureChannelBuffer. | |||
def | Value passed to shouldEnsureChannelBuffer. |
isNodePassthroughChannel(config, def)
Source: src/pipeline/Mapper.js:951
Returns the current node passthrough channel value or state.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to isNodePassthroughChannel. | |||
def | Value passed to isNodePassthroughChannel. |
resolveNodeSourceAttribute(config, def)
Source: src/pipeline/Mapper.js:959
Configures or reads resolve node source attribute.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to resolveNodeSourceAttribute. | |||
def | Value passed to resolveNodeSourceAttribute. |
resolveNodeSourceDimension(sourceAttribute, def)
Source: src/pipeline/Mapper.js:971
Configures or reads resolve node source dimension.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
sourceAttribute | Value passed to resolveNodeSourceDimension. | |||
def | Value passed to resolveNodeSourceDimension. |
resolvePassthroughConfig(config, def, sourceDimension, expectedDimension)
Source: src/pipeline/Mapper.js:988
Configures or reads resolve passthrough config.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to resolvePassthroughConfig. | |||
def | Value passed to resolvePassthroughConfig. | |||
sourceDimension | Value passed to resolvePassthroughConfig. | |||
expectedDimension | Value passed to resolvePassthroughConfig. |
ensureNodeSourceAttribute(sourceAttribute, type, sourceDimension, channelName)
Source: src/pipeline/Mapper.js:1025
Configures or reads ensure node source attribute.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
sourceAttribute | Value passed to ensureNodeSourceAttribute. | |||
type | string | Attribute value type. | ||
sourceDimension | Value passed to ensureNodeSourceAttribute. | |||
channelName | Value passed to ensureNodeSourceAttribute. |
removeEdgeAttribute(name)
Source: src/pipeline/Mapper.js:1113
Manages edge attribute for the current instance.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name | string | Attribute or API identifier. |
unregisterNodeToEdge(attribute)
Source: src/pipeline/Mapper.js:1126
Configures or reads unregister node to edge.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
attribute | Value passed to unregisterNodeToEdge. |
unregisterChannel(config)
Source: src/pipeline/Mapper.js:1139
Configures or reads unregister channel.
Parameters
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
config | Value passed to unregisterChannel. |