maps.nyc.gov

Interface: Symbolizer

nyc.carto.Symbolizer

An interface for symbolizing Carto layers
Source:

Extends

Members

(static) EventType :string

Enumerator for symbolizer event types
Type:
  • string
Properties:
Name Type Description
SYMBOLIZED string The symbolized event fired after a symbolizer completes its symbolize function
Source:

Methods

off(eventName, evtHdlr, hdlrScopeopt)

Remove a previously connected event handler
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

on(eventName, evtHdlr, hdlrScopeopt)

Connect a function to an event
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

one(eventName, evtHdlr, hdlrScopeopt)

Connect a function to an event for a single invocation
Parameters:
Name Type Attributes Description
eventName string The name of the event to which the handler will be connected
evtHdlr function The event handler function
hdlrScope Object <optional>
 The scope in which to invoke the event handler
Inherited From:
Source:

replace(str, values) → {string}

Replace tokens in a string with values from a provided object
Parameters:
Name Type Description
str string String with tokens to be replaced
values Object.<string, string> Values token for replacement
Inherited From:
Source:
Returns:
String with replacement value substitution
Type
string

trigger(eventName, dataopt)

Trigger a named event with event data
Parameters:
Name Type Attributes Description
eventName string The name of the event to trigger
data Object <optional>
 The event data
Inherited From:
Source:

Events

symbolized

The result of symbolization
Type:
  • Object
Source: