visual_map

Method of Figure.

Overloads

Name	Description
visual_map(const Map options) -> Figure	Sets the visualMap option map.
visual_map(const List options) -> Figure	Sets the visualMap option list.

visual_map(const Map options) -> Figure

Sets the visualMap option map.

Parameters

• options: Map of visualMap options.
  • id (string): Component ID.
  • type (string): Type: 'continuous' or 'piecewise'.
  • min (number): Minimum value for visual mapping.
  • max (number): Maximum value for visual mapping.
  • range (List): Selected range for continuous visualMap.
  • unbounded_range (boolean): Treat touching range bounds as unbounded.
  • calculable (boolean): Show draggable handles (continuous).
  • realtime (boolean): Update chart while dragging handles.
  • inverse (boolean): Reverse visualMap layout.
  • precision (number): Label decimal precision.
  • item_width (number): Main bar/item width.
  • item_height (number): Main bar/item height.
  • align (string): Label/handle alignment.
  • text (List): Text labels on both ends.
  • text_gap (number): Gap between text and visualMap body.
  • show (boolean): Show visualMap component.
  • dimension (number|string): Data dimension for visual mapping.
  • series_index (number|string|List): Series indices controlled by visualMap.
  • series_id (number|string|List): Series ids controlled by visualMap.
  • hover_link (boolean): Enable hover linkage with chart elements.
  • split_number (number): Piece count in average piecewise mode.
  • pieces (List): Custom piecewise slices.
  • pieces.value (number|string): Exact value for a piece.
  • pieces.min (number): Piece minimum (inclusive by default).
  • pieces.max (number): Piece maximum (inclusive by default).
  • pieces.lt (number): Piece upper bound (exclusive).
  • pieces.lte (number): Piece upper bound (inclusive).
  • pieces.gt (number): Piece lower bound (exclusive).
  • pieces.gte (number): Piece lower bound (inclusive).
  • pieces.label (string): Piece label.
  • pieces.color (Color): Piece color.
  • categories (List): Categories for categorical piecewise mode.
  • min_open (boolean): Show '< min' piece.
  • max_open (boolean): Show '> max' piece.
  • selected_mode (boolean|string): Selection mode: false/true/'single'/'multiple'.
  • selected (Map): Selected state map for piecewise items.
  • show_label (boolean): Show each piece label.
  • item_gap (number): Gap between piecewise items.
  • item_symbol (string): Piecewise item symbol.
  • left (number|string): Left offset.
  • top (number|string): Top offset.
  • right (number|string): Right offset.
  • bottom (number|string): Bottom offset.
  • orient (string): Orientation: horizontal or vertical.
  • padding (number|List): Component padding.
  • background_color (Color): Component background color.
  • border_color (Color): Component border color.
  • border_width (number): Component border width.
  • zlevel (number): Canvas layer.
  • z (number): Z order.
  • color (List): Legacy color ramp (compatibility).
  • formatter (string): Label formatter string.
  • coordinate_system (string): Layout coordinate system: none/calendar/matrix.
  • coordinate_system_usage (string): Coordinate layout mode: box.
  • coord (List|number|string): Coordinate-system input for layout.
  • calendar_index (number): Calendar index.
  • calendar_id (string|number): Calendar id.
  • matrix_index (number): Matrix index.
  • matrix_id (string|number): Matrix id.
  • target (Map): Series-only visual channel mapping.
  • controller (Map): Controller-only visual channel mapping.
  • text_style (Map): VisualMap text style.
  • handle_icon (string): Continuous handle icon.
  • handle_size (number|string): Continuous handle size.
  • handle_style (Map): Continuous handle style.
  • indicator_icon (string): Continuous indicator icon.
  • indicator_size (number|string): Continuous indicator size.
  • indicator_style (Map): Continuous indicator style.
  • text_style.color (Color): Text color.
  • text_style.font_style (string): Text font style.
  • text_style.font_weight (string|number): Text font weight.
  • text_style.font_family (string): Text font family.
  • text_style.font_size (number): Text font size.
  • text_style.align (string): Text horizontal alignment.
  • text_style.vertical_align (string): Text vertical alignment.
  • text_style.line_height (number): Text line height.
  • text_style.background_color (string|Map): Text background.
  • text_style.border_color (Color): Text border color.
  • text_style.border_width (number): Text border width.
  • text_style.border_type (string|number|List): Text border type.
  • text_style.border_dash_offset (number): Text border dash offset.
  • text_style.border_radius (number): Text border radius.
  • text_style.padding (number|List): Text padding.
  • text_style.shadow_color (Color): Text shadow color.
  • text_style.shadow_blur (number): Text shadow blur.
  • text_style.shadow_offset_x (number): Text shadow offset X.
  • text_style.shadow_offset_y (number): Text shadow offset Y.
  • text_style.width (number): Text width.
  • text_style.height (number): Text height.
  • text_style.text_border_color (Color): Text text stroke color.
  • text_style.text_border_width (number): Text text stroke width.
  • text_style.text_border_type (string|number|List): Text text stroke type.
  • text_style.text_border_dash_offset (number): Text text stroke dash offset.
  • text_style.text_shadow_color (Color): Text text shadow color.
  • text_style.text_shadow_blur (number): Text text shadow blur.
  • text_style.text_shadow_offset_x (number): Text text shadow offset X.
  • text_style.text_shadow_offset_y (number): Text text shadow offset Y.
  • text_style.overflow (string): Text overflow handling.
  • text_style.ellipsis (string): Text ellipsis.
  • text_style.rich (Map): Text rich text styles.
  • text_style.rich_inherit_plain_label (boolean): Rich text inherits plain styles.
  • handle_style.color (Color): Handle color.
  • handle_style.border_color (Color): Handle border color.
  • handle_style.border_width (number): Handle border width.
  • handle_style.border_type (string|number|List): Handle border type.
  • handle_style.border_dash_offset (number): Handle border dash offset.
  • handle_style.border_cap (string): Handle border cap.
  • handle_style.border_join (string): Handle border join.
  • handle_style.border_miter_limit (number): Handle border miter limit.
  • handle_style.shadow_blur (number): Handle shadow blur.
  • handle_style.shadow_color (Color): Handle shadow color.
  • handle_style.shadow_offset_x (number): Handle shadow offset X.
  • handle_style.shadow_offset_y (number): Handle shadow offset Y.
  • handle_style.opacity (number): Handle opacity.
  • indicator_style.color (Color): Indicator color.
  • indicator_style.border_color (Color): Indicator border color.
  • indicator_style.border_width (number): Indicator border width.
  • indicator_style.border_type (string|number|List): Indicator border type.
  • indicator_style.border_dash_offset (number): Indicator border dash offset.
  • indicator_style.border_cap (string): Indicator border cap.
  • indicator_style.border_join (string): Indicator border join.
  • indicator_style.border_miter_limit (number): Indicator border miter limit.
  • indicator_style.shadow_blur (number): Indicator shadow blur.
  • indicator_style.shadow_color (Color): Indicator shadow color.
  • indicator_style.shadow_offset_x (number): Indicator shadow offset X.
  • indicator_style.shadow_offset_y (number): Indicator shadow offset Y.
  • indicator_style.opacity (number): Indicator opacity.
  • in_range (Map): In-range visual channels.
  • in_range.symbol (string|List|Map): Symbol mapping.
  • in_range.symbol_size (number|List|Map): Symbol size mapping.
  • in_range.color (Color|List|Map): Color mapping.
  • in_range.color_alpha (number|List|Map): Alpha mapping.
  • in_range.opacity (number|List|Map): Opacity mapping.
  • in_range.color_lightness (number|List|Map): Lightness mapping.
  • in_range.color_saturation (number|List|Map): Saturation mapping.
  • in_range.color_hue (number|List|Map): Hue mapping.
  • out_of_range (Map): Out-of-range visual channels.
  • out_of_range.symbol (string|List|Map): Symbol mapping.
  • out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • out_of_range.color (Color|List|Map): Color mapping.
  • out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • out_of_range.opacity (number|List|Map): Opacity mapping.
  • out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • out_of_range.color_hue (number|List|Map): Hue mapping.
  • target.in_range (Map): Target in-range visual channels.
  • target.in_range.symbol (string|List|Map): Symbol mapping.
  • target.in_range.symbol_size (number|List|Map): Symbol size mapping.
  • target.in_range.color (Color|List|Map): Color mapping.
  • target.in_range.color_alpha (number|List|Map): Alpha mapping.
  • target.in_range.opacity (number|List|Map): Opacity mapping.
  • target.in_range.color_lightness (number|List|Map): Lightness mapping.
  • target.in_range.color_saturation (number|List|Map): Saturation mapping.
  • target.in_range.color_hue (number|List|Map): Hue mapping.
  • target.out_of_range (Map): Target out-of-range visual channels.
  • target.out_of_range.symbol (string|List|Map): Symbol mapping.
  • target.out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • target.out_of_range.color (Color|List|Map): Color mapping.
  • target.out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • target.out_of_range.opacity (number|List|Map): Opacity mapping.
  • target.out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • target.out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • target.out_of_range.color_hue (number|List|Map): Hue mapping.
  • controller.in_range (Map): Controller in-range visual channels.
  • controller.in_range.symbol (string|List|Map): Symbol mapping.
  • controller.in_range.symbol_size (number|List|Map): Symbol size mapping.
  • controller.in_range.color (Color|List|Map): Color mapping.
  • controller.in_range.color_alpha (number|List|Map): Alpha mapping.
  • controller.in_range.opacity (number|List|Map): Opacity mapping.
  • controller.in_range.color_lightness (number|List|Map): Lightness mapping.
  • controller.in_range.color_saturation (number|List|Map): Saturation mapping.
  • controller.in_range.color_hue (number|List|Map): Hue mapping.
  • controller.out_of_range (Map): Controller out-of-range visual channels.
  • controller.out_of_range.symbol (string|List|Map): Symbol mapping.
  • controller.out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • controller.out_of_range.color (Color|List|Map): Color mapping.
  • controller.out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • controller.out_of_range.opacity (number|List|Map): Opacity mapping.
  • controller.out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • controller.out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • controller.out_of_range.color_hue (number|List|Map): Hue mapping.

visual_map(const List options) -> Figure

Sets the visualMap option list.

Parameters

• options: List of visualMap option maps.
  • id (string): Component ID.
  • type (string): Type: 'continuous' or 'piecewise'.
  • min (number): Minimum value for visual mapping.
  • max (number): Maximum value for visual mapping.
  • range (List): Selected range for continuous visualMap.
  • unbounded_range (boolean): Treat touching range bounds as unbounded.
  • calculable (boolean): Show draggable handles (continuous).
  • realtime (boolean): Update chart while dragging handles.
  • inverse (boolean): Reverse visualMap layout.
  • precision (number): Label decimal precision.
  • item_width (number): Main bar/item width.
  • item_height (number): Main bar/item height.
  • align (string): Label/handle alignment.
  • text (List): Text labels on both ends.
  • text_gap (number): Gap between text and visualMap body.
  • show (boolean): Show visualMap component.
  • dimension (number|string): Data dimension for visual mapping.
  • series_index (number|string|List): Series indices controlled by visualMap.
  • series_id (number|string|List): Series ids controlled by visualMap.
  • hover_link (boolean): Enable hover linkage with chart elements.
  • split_number (number): Piece count in average piecewise mode.
  • pieces (List): Custom piecewise slices.
  • pieces.value (number|string): Exact value for a piece.
  • pieces.min (number): Piece minimum (inclusive by default).
  • pieces.max (number): Piece maximum (inclusive by default).
  • pieces.lt (number): Piece upper bound (exclusive).
  • pieces.lte (number): Piece upper bound (inclusive).
  • pieces.gt (number): Piece lower bound (exclusive).
  • pieces.gte (number): Piece lower bound (inclusive).
  • pieces.label (string): Piece label.
  • pieces.color (Color): Piece color.
  • categories (List): Categories for categorical piecewise mode.
  • min_open (boolean): Show '< min' piece.
  • max_open (boolean): Show '> max' piece.
  • selected_mode (boolean|string): Selection mode: false/true/'single'/'multiple'.
  • selected (Map): Selected state map for piecewise items.
  • show_label (boolean): Show each piece label.
  • item_gap (number): Gap between piecewise items.
  • item_symbol (string): Piecewise item symbol.
  • left (number|string): Left offset.
  • top (number|string): Top offset.
  • right (number|string): Right offset.
  • bottom (number|string): Bottom offset.
  • orient (string): Orientation: horizontal or vertical.
  • padding (number|List): Component padding.
  • background_color (Color): Component background color.
  • border_color (Color): Component border color.
  • border_width (number): Component border width.
  • zlevel (number): Canvas layer.
  • z (number): Z order.
  • color (List): Legacy color ramp (compatibility).
  • formatter (string): Label formatter string.
  • coordinate_system (string): Layout coordinate system: none/calendar/matrix.
  • coordinate_system_usage (string): Coordinate layout mode: box.
  • coord (List|number|string): Coordinate-system input for layout.
  • calendar_index (number): Calendar index.
  • calendar_id (string|number): Calendar id.
  • matrix_index (number): Matrix index.
  • matrix_id (string|number): Matrix id.
  • target (Map): Series-only visual channel mapping.
  • controller (Map): Controller-only visual channel mapping.
  • text_style (Map): VisualMap text style.
  • handle_icon (string): Continuous handle icon.
  • handle_size (number|string): Continuous handle size.
  • handle_style (Map): Continuous handle style.
  • indicator_icon (string): Continuous indicator icon.
  • indicator_size (number|string): Continuous indicator size.
  • indicator_style (Map): Continuous indicator style.
  • text_style.color (Color): Text color.
  • text_style.font_style (string): Text font style.
  • text_style.font_weight (string|number): Text font weight.
  • text_style.font_family (string): Text font family.
  • text_style.font_size (number): Text font size.
  • text_style.align (string): Text horizontal alignment.
  • text_style.vertical_align (string): Text vertical alignment.
  • text_style.line_height (number): Text line height.
  • text_style.background_color (string|Map): Text background.
  • text_style.border_color (Color): Text border color.
  • text_style.border_width (number): Text border width.
  • text_style.border_type (string|number|List): Text border type.
  • text_style.border_dash_offset (number): Text border dash offset.
  • text_style.border_radius (number): Text border radius.
  • text_style.padding (number|List): Text padding.
  • text_style.shadow_color (Color): Text shadow color.
  • text_style.shadow_blur (number): Text shadow blur.
  • text_style.shadow_offset_x (number): Text shadow offset X.
  • text_style.shadow_offset_y (number): Text shadow offset Y.
  • text_style.width (number): Text width.
  • text_style.height (number): Text height.
  • text_style.text_border_color (Color): Text text stroke color.
  • text_style.text_border_width (number): Text text stroke width.
  • text_style.text_border_type (string|number|List): Text text stroke type.
  • text_style.text_border_dash_offset (number): Text text stroke dash offset.
  • text_style.text_shadow_color (Color): Text text shadow color.
  • text_style.text_shadow_blur (number): Text text shadow blur.
  • text_style.text_shadow_offset_x (number): Text text shadow offset X.
  • text_style.text_shadow_offset_y (number): Text text shadow offset Y.
  • text_style.overflow (string): Text overflow handling.
  • text_style.ellipsis (string): Text ellipsis.
  • text_style.rich (Map): Text rich text styles.
  • text_style.rich_inherit_plain_label (boolean): Rich text inherits plain styles.
  • handle_style.color (Color): Handle color.
  • handle_style.border_color (Color): Handle border color.
  • handle_style.border_width (number): Handle border width.
  • handle_style.border_type (string|number|List): Handle border type.
  • handle_style.border_dash_offset (number): Handle border dash offset.
  • handle_style.border_cap (string): Handle border cap.
  • handle_style.border_join (string): Handle border join.
  • handle_style.border_miter_limit (number): Handle border miter limit.
  • handle_style.shadow_blur (number): Handle shadow blur.
  • handle_style.shadow_color (Color): Handle shadow color.
  • handle_style.shadow_offset_x (number): Handle shadow offset X.
  • handle_style.shadow_offset_y (number): Handle shadow offset Y.
  • handle_style.opacity (number): Handle opacity.
  • indicator_style.color (Color): Indicator color.
  • indicator_style.border_color (Color): Indicator border color.
  • indicator_style.border_width (number): Indicator border width.
  • indicator_style.border_type (string|number|List): Indicator border type.
  • indicator_style.border_dash_offset (number): Indicator border dash offset.
  • indicator_style.border_cap (string): Indicator border cap.
  • indicator_style.border_join (string): Indicator border join.
  • indicator_style.border_miter_limit (number): Indicator border miter limit.
  • indicator_style.shadow_blur (number): Indicator shadow blur.
  • indicator_style.shadow_color (Color): Indicator shadow color.
  • indicator_style.shadow_offset_x (number): Indicator shadow offset X.
  • indicator_style.shadow_offset_y (number): Indicator shadow offset Y.
  • indicator_style.opacity (number): Indicator opacity.
  • in_range (Map): In-range visual channels.
  • in_range.symbol (string|List|Map): Symbol mapping.
  • in_range.symbol_size (number|List|Map): Symbol size mapping.
  • in_range.color (Color|List|Map): Color mapping.
  • in_range.color_alpha (number|List|Map): Alpha mapping.
  • in_range.opacity (number|List|Map): Opacity mapping.
  • in_range.color_lightness (number|List|Map): Lightness mapping.
  • in_range.color_saturation (number|List|Map): Saturation mapping.
  • in_range.color_hue (number|List|Map): Hue mapping.
  • out_of_range (Map): Out-of-range visual channels.
  • out_of_range.symbol (string|List|Map): Symbol mapping.
  • out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • out_of_range.color (Color|List|Map): Color mapping.
  • out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • out_of_range.opacity (number|List|Map): Opacity mapping.
  • out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • out_of_range.color_hue (number|List|Map): Hue mapping.
  • target.in_range (Map): Target in-range visual channels.
  • target.in_range.symbol (string|List|Map): Symbol mapping.
  • target.in_range.symbol_size (number|List|Map): Symbol size mapping.
  • target.in_range.color (Color|List|Map): Color mapping.
  • target.in_range.color_alpha (number|List|Map): Alpha mapping.
  • target.in_range.opacity (number|List|Map): Opacity mapping.
  • target.in_range.color_lightness (number|List|Map): Lightness mapping.
  • target.in_range.color_saturation (number|List|Map): Saturation mapping.
  • target.in_range.color_hue (number|List|Map): Hue mapping.
  • target.out_of_range (Map): Target out-of-range visual channels.
  • target.out_of_range.symbol (string|List|Map): Symbol mapping.
  • target.out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • target.out_of_range.color (Color|List|Map): Color mapping.
  • target.out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • target.out_of_range.opacity (number|List|Map): Opacity mapping.
  • target.out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • target.out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • target.out_of_range.color_hue (number|List|Map): Hue mapping.
  • controller.in_range (Map): Controller in-range visual channels.
  • controller.in_range.symbol (string|List|Map): Symbol mapping.
  • controller.in_range.symbol_size (number|List|Map): Symbol size mapping.
  • controller.in_range.color (Color|List|Map): Color mapping.
  • controller.in_range.color_alpha (number|List|Map): Alpha mapping.
  • controller.in_range.opacity (number|List|Map): Opacity mapping.
  • controller.in_range.color_lightness (number|List|Map): Lightness mapping.
  • controller.in_range.color_saturation (number|List|Map): Saturation mapping.
  • controller.in_range.color_hue (number|List|Map): Hue mapping.
  • controller.out_of_range (Map): Controller out-of-range visual channels.
  • controller.out_of_range.symbol (string|List|Map): Symbol mapping.
  • controller.out_of_range.symbol_size (number|List|Map): Symbol size mapping.
  • controller.out_of_range.color (Color|List|Map): Color mapping.
  • controller.out_of_range.color_alpha (number|List|Map): Alpha mapping.
  • controller.out_of_range.opacity (number|List|Map): Opacity mapping.
  • controller.out_of_range.color_lightness (number|List|Map): Lightness mapping.
  • controller.out_of_range.color_saturation (number|List|Map): Saturation mapping.
  • controller.out_of_range.color_hue (number|List|Map): Hue mapping.