maps.nyc.gov

Class: JenksSymbolizer

nyc.carto.JenksSymbolizer

new JenksSymbolizer(options)

Class for managing SQL views on layers
Parameters:
Name Type Description
options nyc.carto.JenksSymbolizer.Options Constructor options
Mixes In:
Source:
Fires:

Extends

Members

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
Mixes In:
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:

symbolize(layer)

Parameters:
Name Type Description
layer cartodb.CartoDBLayer.SubLayer The layer to symbolize
Source:

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:

Type Definitions

Options

Object type to hold constructor options for nyc.carto.SqlJenksSymbolizer
Type:
  • Object
Properties:
Name Type Attributes Description
cartoSql cartodb.SQL The object used to query Carto data
jenksColumn string The data column for calculating Jenks natural breaks in the data
cssRules Array.<string> An array of CartoCSS with the token ${value} to be replaced by the Jenks calculated values
baseCss string <optional>
 CartoCSS that remains unchanged regardless of changing data
outlierFilter string <optional>
 An SQL condition used to restrict the data used in the Jenks calculation
Source:

Events

symbolized

The Jenks breaks applied to the CartoCS of the layer
Type:
  • Array.<number>
Source: