Add extra details to charts
Set functionsSet audio chart detailsSet bar chart race chart detailsSet bubble chart chart detailsSet calculator chart detailsSet cards chart detailsSet chord diagram chart detailsSet countdown chart detailsSet draw the line chart chart detailsSet election results chart chart detailsSet gantt chart chart detailsSet gauge chart detailsSet hierarchy chart detailsSet line chart race chart detailsSet interactive svg chart detailsSet line, bar and pie charts chart detailsSet marimekko chart detailsSet network graph chart detailsSet number ticker chart detailsSet parliament chart chart detailsSet photo slider chart detailsSet pictogram chart detailsSet quiz chart detailsSet radar chart chart detailsSet sankey diagram chart detailsSet scatter chart detailsSet slope chart chart detailsSet sports chart detailsSet sports race chart detailsSet survey chart detailsSet svg annotator chart detailsSet table chart detailsSet text annotator chart detailsSet timeline chart detailsSet tournament chart detailsSet word cloud chart details
Set text annotator chart details
Usage
def set_text_annotator_details(self,text: Union[list, str] = None,highlight_color: str = None,layout_align: str = None,text_container_width: float = None,text_font_size: float = None,text_font_color: str = None,text_font_color_highlighted: str = None,text_font_color_highlighted_contrast: str = None,text_highlight_type: str = None,text_highlight_handdrawn: str = None,highlighted_stroke_end: str = None,highlighted_stroke_amount: float = None,highlighted_stroke_width: float = None,note_type: str = None,note_visibility: str = None,note_font_size: float = None,side_panel_width: float = None,note_font_color: str = None,note_background_color: str = None,note_custom_content: Union[list, str] = None,note_mobile_mode: str = None,chart_layout_body_font: str = None,chart_layout_font_color: str = None,chart_layout_background_color_enabled: bool = None,chart_layout_background_image_enabled: bool = None,chart_layout_background_color: str = None,chart_layout_background_image_src: str = None,chart_layout_background_image_size: str = None,chart_layout_background_image_position: str = None,chart_layout_max_width_target: str = None,chart_layout_max_width: float = None,chart_layout_max_width_align: str = None,chart_layout_layout_order: str = None,chart_layout_space_between_sections: str = None,chart_layout_space_between_sections_custom: float = None,chart_layout_margin_top: float = None,chart_layout_margin_right: float = None,chart_layout_margin_bottom: float = None,chart_layout_margin_left: float = None,chart_layout_border_enabled: bool = None,chart_layout_border_top_width: float = None,chart_layout_border_top_style: str = None,chart_layout_border_top_color: str = None,chart_layout_border_right_width: float = None,chart_layout_border_right_style: str = None,chart_layout_border_right_color: str = None,chart_layout_border_bottom_width: float = None,chart_layout_border_bottom_style: str = None,chart_layout_border_bottom_color: str = None,chart_layout_border_left_width: float = None,chart_layout_border_left_style: str = None,chart_layout_border_left_color: str = None,chart_layout_read_direction: str = None,chart_layout_font_size_mobile_small: float = None,chart_layout_font_size_mobile_big: float = None,chart_layout_font_size_tablet: float = None,chart_layout_font_size_desktop: float = None,chart_layout_font_size_big_screen: float = None,chart_layout_breakpoint_mobile_small: float = None,chart_layout_breakpoint_mobile_big: float = None,chart_layout_breakpoint_tablet: float = None,chart_layout_breakpoint_desktop: float = None,chart_layout_breakpoint_big_screen: float = None,chart_layout_header_align: str = None,chart_layout_title: Union[list, str] = None,chart_layout_title_styling: bool = None,chart_layout_title_font: str = None,chart_layout_title_size: str = None,chart_layout_title_size_custom: float = None,chart_layout_title_weight: str = None,chart_layout_title_color: str = None,chart_layout_title_line_height: float = None,chart_layout_title_space_above: str = None,chart_layout_title_space_above_custom: float = None,chart_layout_subtitle: Union[list, str] = None,chart_layout_subtitle_styling: bool = None,chart_layout_subtitle_font: str = None,chart_layout_subtitle_size: str = None,chart_layout_subtitle_size_custom: float = None,chart_layout_subtitle_weight: str = None,chart_layout_subtitle_color: str = None,chart_layout_subtitle_line_height: float = None,chart_layout_subtitle_space_above: str = None,chart_layout_subtitle_space_above_custom: float = None,chart_layout_header_text: Union[list, str] = None,chart_layout_header_text_styling: bool = None,chart_layout_header_text_size: str = None,chart_layout_header_text_size_custom: float = None,chart_layout_header_text_weight: str = None,chart_layout_header_text_color: str = None,chart_layout_header_text_line_height: float = None,chart_layout_header_text_space_above: str = None,chart_layout_header_text_space_above_custom: float = None,chart_layout_header_border: str = None,chart_layout_header_border_width: float = None,chart_layout_header_border_color: str = None,chart_layout_header_border_style: str = None,chart_layout_header_border_space: float = None,chart_layout_header_logo_enabled: bool = None,chart_layout_header_logo_src: str = None,chart_layout_header_logo_alt: str = None,chart_layout_header_logo_link_url: str = None,chart_layout_header_logo_height: float = None,chart_layout_header_logo_align: str = None,chart_layout_header_logo_position_inside: str = None,chart_layout_header_logo_position_outside: str = None,chart_layout_header_logo_margin_top: float = None,chart_layout_header_logo_margin_right: float = None,chart_layout_header_logo_margin_bottom: float = None,chart_layout_header_logo_margin_left: float = None,chart_layout_footer_align: str = None,chart_layout_footer_text_size: float = None,chart_layout_footer_text_color: str = None,chart_layout_footer_styling: bool = None,chart_layout_footer_font: str = None,chart_layout_footer_text_weight: str = None,chart_layout_source_name: str = None,chart_layout_source_url: str = None,chart_layout_multiple_sources: bool = None,chart_layout_source_name_2: str = None,chart_layout_source_url_2: str = None,chart_layout_source_name_3: str = None,chart_layout_source_url_3: str = None,chart_layout_source_label: str = None,chart_layout_footer_note: Union[list, str] = None,chart_layout_footer_note_secondary: Union[list, str] = None,chart_layout_advanced_note_styling: bool = None,chart_layout_footer_timestamp_format: str = None,chart_layout_footer_logo_enabled: bool = None,chart_layout_footer_logo_src: str = None,chart_layout_footer_logo_src_light: str = None,chart_layout_footer_logo_alt: str = None,chart_layout_footer_logo_link_url: str = None,chart_layout_footer_logo_height: float = None,chart_layout_footer_logo_margin: float = None,chart_layout_footer_logo_order: str = None,chart_layout_footer_align_vertical: str = None,chart_layout_footer_border: str = None,chart_layout_footer_border_width: float = None,chart_layout_footer_border_color: str = None,chart_layout_footer_border_style: str = None,chart_layout_footer_border_space: float = None,chart_layout_screenreader_text_primary: Union[list, str] = None,chart_layout_screenreader_label: str = None,chart_layout_screenreader_hide_primary: bool = None)
PYTHON
set_text_annotator_details(.,text = NULL,highlight_color = NULL,layout_align = NULL,text_container_width = NULL,text_font_size = NULL,text_font_color = NULL,text_font_color_highlighted = NULL,text_font_color_highlighted_contrast = NULL,text_highlight_type = NULL,text_highlight_handdrawn = NULL,highlighted_stroke_end = NULL,highlighted_stroke_amount = NULL,highlighted_stroke_width = NULL,note_type = NULL,note_visibility = NULL,note_font_size = NULL,side_panel_width = NULL,note_font_color = NULL,note_background_color = NULL,note_custom_content = NULL,note_mobile_mode = NULL,chart_layout_body_font = NULL,chart_layout_font_color = NULL,chart_layout_background_color_enabled = NULL,chart_layout_background_image_enabled = NULL,chart_layout_background_color = NULL,chart_layout_background_image_src = NULL,chart_layout_background_image_size = NULL,chart_layout_background_image_position = NULL,chart_layout_max_width_target = NULL,chart_layout_max_width = NULL,chart_layout_max_width_align = NULL,chart_layout_layout_order = NULL,chart_layout_space_between_sections = NULL,chart_layout_space_between_sections_custom = NULL,chart_layout_margin_top = NULL,chart_layout_margin_right = NULL,chart_layout_margin_bottom = NULL,chart_layout_margin_left = NULL,chart_layout_border_enabled = NULL,chart_layout_border_top_width = NULL,chart_layout_border_top_style = NULL,chart_layout_border_top_color = NULL,chart_layout_border_right_width = NULL,chart_layout_border_right_style = NULL,chart_layout_border_right_color = NULL,chart_layout_border_bottom_width = NULL,chart_layout_border_bottom_style = NULL,chart_layout_border_bottom_color = NULL,chart_layout_border_left_width = NULL,chart_layout_border_left_style = NULL,chart_layout_border_left_color = NULL,chart_layout_read_direction = NULL,chart_layout_font_size_mobile_small = NULL,chart_layout_font_size_mobile_big = NULL,chart_layout_font_size_tablet = NULL,chart_layout_font_size_desktop = NULL,chart_layout_font_size_big_screen = NULL,chart_layout_breakpoint_mobile_small = NULL,chart_layout_breakpoint_mobile_big = NULL,chart_layout_breakpoint_tablet = NULL,chart_layout_breakpoint_desktop = NULL,chart_layout_breakpoint_big_screen = NULL,chart_layout_header_align = NULL,chart_layout_title = NULL,chart_layout_title_styling = NULL,chart_layout_title_font = NULL,chart_layout_title_size = NULL,chart_layout_title_size_custom = NULL,chart_layout_title_weight = NULL,chart_layout_title_color = NULL,chart_layout_title_line_height = NULL,chart_layout_title_space_above = NULL,chart_layout_title_space_above_custom = NULL,chart_layout_subtitle = NULL,chart_layout_subtitle_styling = NULL,chart_layout_subtitle_font = NULL,chart_layout_subtitle_size = NULL,chart_layout_subtitle_size_custom = NULL,chart_layout_subtitle_weight = NULL,chart_layout_subtitle_color = NULL,chart_layout_subtitle_line_height = NULL,chart_layout_subtitle_space_above = NULL,chart_layout_subtitle_space_above_custom = NULL,chart_layout_header_text = NULL,chart_layout_header_text_styling = NULL,chart_layout_header_text_size = NULL,chart_layout_header_text_size_custom = NULL,chart_layout_header_text_weight = NULL,chart_layout_header_text_color = NULL,chart_layout_header_text_line_height = NULL,chart_layout_header_text_space_above = NULL,chart_layout_header_text_space_above_custom = NULL,chart_layout_header_border = NULL,chart_layout_header_border_width = NULL,chart_layout_header_border_color = NULL,chart_layout_header_border_style = NULL,chart_layout_header_border_space = NULL,chart_layout_header_logo_enabled = NULL,chart_layout_header_logo_src = NULL,chart_layout_header_logo_alt = NULL,chart_layout_header_logo_link_url = NULL,chart_layout_header_logo_height = NULL,chart_layout_header_logo_align = NULL,chart_layout_header_logo_position_inside = NULL,chart_layout_header_logo_position_outside = NULL,chart_layout_header_logo_margin_top = NULL,chart_layout_header_logo_margin_right = NULL,chart_layout_header_logo_margin_bottom = NULL,chart_layout_header_logo_margin_left = NULL,chart_layout_footer_align = NULL,chart_layout_footer_text_size = NULL,chart_layout_footer_text_color = NULL,chart_layout_footer_styling = NULL,chart_layout_footer_font = NULL,chart_layout_footer_text_weight = NULL,chart_layout_source_name = NULL,chart_layout_source_url = NULL,chart_layout_multiple_sources = NULL,chart_layout_source_name_2 = NULL,chart_layout_source_url_2 = NULL,chart_layout_source_name_3 = NULL,chart_layout_source_url_3 = NULL,chart_layout_source_label = NULL,chart_layout_footer_note = NULL,chart_layout_footer_note_secondary = NULL,chart_layout_advanced_note_styling = NULL,chart_layout_footer_timestamp_format = NULL,chart_layout_footer_logo_enabled = NULL,chart_layout_footer_logo_src = NULL,chart_layout_footer_logo_src_light = NULL,chart_layout_footer_logo_alt = NULL,chart_layout_footer_logo_link_url = NULL,chart_layout_footer_logo_height = NULL,chart_layout_footer_logo_margin = NULL,chart_layout_footer_logo_order = NULL,chart_layout_footer_align_vertical = NULL,chart_layout_footer_border = NULL,chart_layout_footer_border_width = NULL,chart_layout_footer_border_color = NULL,chart_layout_footer_border_style = NULL,chart_layout_footer_border_space = NULL,chart_layout_screenreader_text_primary = NULL,chart_layout_screenreader_label = NULL,chart_layout_screenreader_hide_primary = NULL)
R
Arguments
Arguments | Type hint | Description |
---|---|---|
self | Flourish | Returns the Flourish object |
text | Union[list, str] , optional | Text. Fill in the text you want to annotate In the datasheet, you can write which parts of the text should be annotated. If you want to annotate a specific part of the text that occurs more than once, you can add identifiers to your text. For example, "Id like to annotate the word beautiful{beautiful-annotation}." Then, in the datasheet, you can write "beautiful-annotation" in the first column and the text to include in the annotation in the second column. Flourish type hint: html, defaults to None |
highlight_color | str , optional | Highlight color. Flourish type hint: color, defaults to None |
layout_align | str , optional | Align. Choices: center, start. Flourish type hint: string, defaults to None |
text_container_width | float , optional | Width. Max width of text container. Flourish type hint: number, defaults to None |
text_font_size | float , optional | Font size. In rems, a multiple of the pages base font size. Flourish type hint: number, defaults to None |
text_font_color | str , optional | Text color. Flourish type hint: color, defaults to None |
text_font_color_highlighted | str , optional | Text color (highlighted). Flourish type hint: color, defaults to None |
text_font_color_highlighted_contrast | str , optional | Text color (highlighted). Flourish type hint: color, defaults to None |
text_highlight_type | str , optional | Highlight type. Choices: handdrawn, background, text_color, underline. Flourish type hint: string, defaults to None |
text_highlight_handdrawn | str , optional | Handdrawn type. Choices: circle, highlight, box, underline. Flourish type hint: string, defaults to None |
highlighted_stroke_end | str , optional | Stroke end. Choices: round,Flourish type hint: string, defaults to None |
highlighted_stroke_amount | float , optional | Iterations. Number of lines to draw. Flourish type hint: number, defaults to None |
highlighted_stroke_width | float , optional | Thickness. Flourish type hint: number, defaults to None |
note_type | str , optional | Mode. Choices: side-panel, inline. Flourish type hint: string, defaults to None |
note_visibility | str , optional | Show notes. Choices: always, click. Flourish type hint: string, defaults to None |
note_font_size | float , optional | Text size. Flourish type hint: number, defaults to None |
side_panel_width | float , optional | Width. Max width of side panel. Flourish type hint: number, defaults to None |
note_font_color | str , optional | Text color. Flourish type hint: color, defaults to None |
note_background_color | str , optional | Background color. Flourish type hint: color, defaults to None |
note_custom_content | Union[list, str] , optional | Note content. Use {{NOTE}} to show the annotation content. Use this setting to add prefixes, suffixes or additional HTML styling to your annotations. Flourish type hint: html, defaults to None |
note_mobile_mode | str , optional | Mobile mode. Choices: side-panel, inline, overlay. Choose where to display the notes on smaller screens. Flourish type hint: string, defaults to None |
chart_layout_body_font | str , optional | Main font. This font will apply to the whole graphic by default. You can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels. Flourish type hint: font, defaults to None |
chart_layout_font_color | str , optional | Text color. This color will apply to the whole graphic by default, You can optionally change the color for individual text elements, in other settings panels. Flourish type hint: color, defaults to None |
chart_layout_background_color_enabled | bool , optional | Color. Choices: True, False. Flourish type hint: boolean, defaults to None |
chart_layout_background_image_enabled | bool , optional | Image. Choices: True, False. Flourish type hint: boolean, defaults to None |
chart_layout_background_color | str , optional | Background color. Flourish type hint: color, defaults to None |
chart_layout_background_image_src | str , optional | Image URL. Flourish type hint: url, defaults to None |
chart_layout_background_image_size | str , optional | Size. Choices: cover, contain, auto, 100% 100%. Flourish type hint: string, defaults to None |
chart_layout_background_image_position | str , optional | Position. Choices: top left, top center, top right, center left, center center, center right, bottom left, bottom center, bottom right. Flourish type hint: string, defaults to None |
chart_layout_max_width_target | str , optional | Maximum width. Choices: none, wrapper, primary. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc). Flourish type hint: string, defaults to None |
chart_layout_max_width | float , optional | Maximum width. Leave blank to stretch to container width. Flourish type hint: number, defaults to None |
chart_layout_max_width_align | str , optional | Align. Choices: left, center, right. Flourish type hint: string, defaults to None |
chart_layout_layout_order | str , optional | Layout order. Flourish type hint: string, defaults to None |
chart_layout_space_between_sections | str , optional | Space between sections. Choices: 0.5, 1, 1.5, custom. Flourish type hint: string, defaults to None |
chart_layout_space_between_sections_custom | float , optional | Custom. Flourish type hint: number, defaults to None |
chart_layout_margin_top | float , optional | Top. Flourish type hint: number, defaults to None |
chart_layout_margin_right | float , optional | Right. Flourish type hint: number, defaults to None |
chart_layout_margin_bottom | float , optional | Bottom. Flourish type hint: number, defaults to None |
chart_layout_margin_left | float , optional | Left. Flourish type hint: number, defaults to None |
chart_layout_border_enabled | bool , optional | Show borders around visualisation. Flourish type hint: boolean, defaults to None |
chart_layout_border_top_width | float , optional | Top. Flourish type hint: number, defaults to None |
chart_layout_border_top_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_border_top_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_border_right_width | float , optional | Right. Flourish type hint: number, defaults to None |
chart_layout_border_right_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_border_right_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_border_bottom_width | float , optional | Bottom. Flourish type hint: number, defaults to None |
chart_layout_border_bottom_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_border_bottom_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_border_left_width | float , optional | Left. Flourish type hint: number, defaults to None |
chart_layout_border_left_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_border_left_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_read_direction | str , optional | Read direction. Choices: ltr, rtl. This will change the reading direction of the main text elements on the page. Its not possible to adjust this on all elements, such as axes. Note that when direction is set to right to left any alignment icons will be reversed. Flourish type hint: string, defaults to None |
chart_layout_font_size_mobile_small | float , optional | Flourish type hint: number, defaults to None |
chart_layout_font_size_mobile_big | float , optional | Flourish type hint: number, defaults to None |
chart_layout_font_size_tablet | float , optional | Flourish type hint: number, defaults to None |
chart_layout_font_size_desktop | float , optional | Flourish type hint: number, defaults to None |
chart_layout_font_size_big_screen | float , optional | Flourish type hint: number, defaults to None |
chart_layout_breakpoint_mobile_small | float , optional | Flourish type hint: number, defaults to None |
chart_layout_breakpoint_mobile_big | float , optional | Flourish type hint: number, defaults to None |
chart_layout_breakpoint_tablet | float , optional | Flourish type hint: number, defaults to None |
chart_layout_breakpoint_desktop | float , optional | Flourish type hint: number, defaults to None |
chart_layout_breakpoint_big_screen | float , optional | Flourish type hint: number, defaults to None |
chart_layout_header_align | str , optional | Alignment. Choices: left, center, right. Flourish type hint: string, defaults to None |
chart_layout_title | Union[list, str] , optional | Flourish type hint: html, defaults to None |
chart_layout_title_styling | bool , optional | Styling. Flourish type hint: boolean, defaults to None |
chart_layout_title_font | str , optional | Title Font. Flourish type hint: font, defaults to None |
chart_layout_title_size | str , optional | Size. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to None |
chart_layout_title_size_custom | float , optional | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to None |
chart_layout_title_weight | str , optional | Weight. Choices: bold, normal. Flourish type hint: string, defaults to None |
chart_layout_title_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_title_line_height | float , optional | Line height. Flourish type hint: number, defaults to None |
chart_layout_title_space_above | str , optional | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None |
chart_layout_title_space_above_custom | float , optional | Custom. Flourish type hint: number, defaults to None |
chart_layout_subtitle | Union[list, str] , optional | Flourish type hint: html, defaults to None |
chart_layout_subtitle_styling | bool , optional | Styling. Flourish type hint: boolean, defaults to None |
chart_layout_subtitle_font | str , optional | Subtitle Font. Flourish type hint: font, defaults to None |
chart_layout_subtitle_size | str , optional | Size. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to None |
chart_layout_subtitle_size_custom | float , optional | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to None |
chart_layout_subtitle_weight | str , optional | Weight. Choices: bold, normal. Flourish type hint: string, defaults to None |
chart_layout_subtitle_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_subtitle_line_height | float , optional | Line height. Flourish type hint: number, defaults to None |
chart_layout_subtitle_space_above | str , optional | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None |
chart_layout_subtitle_space_above_custom | float , optional | Custom. Flourish type hint: number, defaults to None |
chart_layout_header_text | Union[list, str] , optional | Flourish type hint: html, defaults to None |
chart_layout_header_text_styling | bool , optional | Styling. Flourish type hint: boolean, defaults to None |
chart_layout_header_text_size | str , optional | Size. Choices: 1.2, 1.4, 1.6, custom. Flourish type hint: string, defaults to None |
chart_layout_header_text_size_custom | float , optional | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to None |
chart_layout_header_text_weight | str , optional | Weight. Choices: bold, normal. Flourish type hint: string, defaults to None |
chart_layout_header_text_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_header_text_line_height | float , optional | Line height. Flourish type hint: number, defaults to None |
chart_layout_header_text_space_above | str , optional | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None |
chart_layout_header_text_space_above_custom | float , optional | Custom. Flourish type hint: number, defaults to None |
chart_layout_header_border | str , optional | Choices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to None |
chart_layout_header_border_width | float , optional | Width. Flourish type hint: number, defaults to None |
chart_layout_header_border_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_header_border_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_header_border_space | float , optional | Space. Space between border and header text. Flourish type hint: number, defaults to None |
chart_layout_header_logo_enabled | bool , optional | Choices: True, False. Flourish type hint: boolean, defaults to None |
chart_layout_header_logo_src | str , optional | Image. Flourish type hint: url, defaults to None |
chart_layout_header_logo_alt | str , optional | Alt text. Flourish type hint: string, defaults to None |
chart_layout_header_logo_link_url | str , optional | Link. Flourish type hint: string, defaults to None |
chart_layout_header_logo_height | float , optional | Height. Flourish type hint: number, defaults to None |
chart_layout_header_logo_align | str , optional | Align. Choices: inside, outside. Align logo inside either the header or the main visualization container. Flourish type hint: string, defaults to None |
chart_layout_header_logo_position_inside | str , optional | Position. Choices: top, left, right. Flourish type hint: string, defaults to None |
chart_layout_header_logo_position_outside | str , optional | Position. Choices: left, right. Flourish type hint: string, defaults to None |
chart_layout_header_logo_margin_top | float , optional | Top. Flourish type hint: number, defaults to None |
chart_layout_header_logo_margin_right | float , optional | Right. Flourish type hint: number, defaults to None |
chart_layout_header_logo_margin_bottom | float , optional | Bottom. Flourish type hint: number, defaults to None |
chart_layout_header_logo_margin_left | float , optional | Left. Flourish type hint: number, defaults to None |
chart_layout_footer_align | str , optional | Alignment. Choices: left, center, right, justify. Flourish type hint: string, defaults to None |
chart_layout_footer_text_size | float , optional | Size. Flourish type hint: number, defaults to None |
chart_layout_footer_text_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_footer_styling | bool , optional | Advanced footer styles. Flourish type hint: boolean, defaults to None |
chart_layout_footer_font | str , optional | Font. Flourish type hint: font, defaults to None |
chart_layout_footer_text_weight | str , optional | Weight. Choices: bold, normal. Flourish type hint: string, defaults to None |
chart_layout_source_name | str , optional | Source name. Flourish type hint: string, defaults to None |
chart_layout_source_url | str , optional | Source url. Flourish type hint: string, defaults to None |
chart_layout_multiple_sources | bool , optional | Multiple sources. Flourish type hint: boolean, defaults to None |
chart_layout_source_name_2 | str , optional | Source name. Flourish type hint: string, defaults to None |
chart_layout_source_url_2 | str , optional | Source url. Flourish type hint: string, defaults to None |
chart_layout_source_name_3 | str , optional | Source name. Flourish type hint: string, defaults to None |
chart_layout_source_url_3 | str , optional | Source url. Flourish type hint: string, defaults to None |
chart_layout_source_label | str , optional | Source label. Flourish type hint: string, defaults to None |
chart_layout_footer_note | Union[list, str] , optional | Note. To add the time/date stamp of when the data was last updated add {{data_last_updated}} . For example, "Last updated at {{data_last_updated}} ". To customize the format, use the advanced options below. Flourish type hint: html, defaults to None |
chart_layout_footer_note_secondary | Union[list, str] , optional | Note (secondary). The secondary note is placed below the source and primary note. To add the time/date stamp of when the data was last updated add {{data_last_updated}} . For example, "Last updated at {{data_last_updated}} ". To customize the format, use the advanced options below. Flourish type hint: html, defaults to None |
chart_layout_advanced_note_styling | bool , optional | Advanced. Flourish type hint: boolean, defaults to None |
chart_layout_footer_timestamp_format | str , optional | Time/date stamp formatting. Choices: %H:%M:%S, %I:%M %p, %H:%M, %H:%M %p, %H:%M:%S, %d %b %Y, %H:%M, %d %b %Y, %H:%M, %d/%m/%Y, %H:%M, %m/%d/%Y, %H:%M, %d-%m-%Y, %H:%M, %m-%d-%Y, %d %b %Y, %m/%d/%Y, %d/%m/%Y, %m-%d-%Y, %d-%m-%Y, %Y-%m-%d, %Y-%m-%d %H:%M:%S. Flourish type hint: string, defaults to None |
chart_layout_footer_logo_enabled | bool , optional | Image. Choices: True, False. Flourish type hint: boolean, defaults to None |
chart_layout_footer_logo_src | str , optional | Image. Flourish type hint: url, defaults to None |
chart_layout_footer_logo_src_light | str , optional | Image (light version). If provided this version will be used whenever the background color is dark. Flourish type hint: hidden, defaults to None |
chart_layout_footer_logo_alt | str , optional | Alt text. Flourish type hint: string, defaults to None |
chart_layout_footer_logo_link_url | str , optional | Link. Flourish type hint: string, defaults to None |
chart_layout_footer_logo_height | float , optional | Height. Flourish type hint: number, defaults to None |
chart_layout_footer_logo_margin | float , optional | Margin. Flourish type hint: number, defaults to None |
chart_layout_footer_logo_order | str , optional | Position. Choices: left, right. Flourish type hint: string, defaults to None |
chart_layout_footer_align_vertical | str , optional | V. align. Choices: flex-start, center, flex-end. Flourish type hint: string, defaults to None |
chart_layout_footer_border | str , optional | Choices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to None |
chart_layout_footer_border_width | float , optional | Width. Flourish type hint: number, defaults to None |
chart_layout_footer_border_color | str , optional | Color. Flourish type hint: color, defaults to None |
chart_layout_footer_border_style | str , optional | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None |
chart_layout_footer_border_space | float , optional | Space. Space between border and footer text. Flourish type hint: number, defaults to None |
chart_layout_screenreader_text_primary | Union[list, str] , optional | Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. The line chart shows China consistently higher than the other countries since 1990. Do not replicate your title, since that will also be read by screenreaders. Flourish type hint: text, defaults to None |
chart_layout_screenreader_label | str , optional | Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to screenreaders Added in the form of an "aria-label". Flourish type hint: string, defaults to None |
chart_layout_screenreader_hide_primary | bool , optional | Screenreader mode for main visual container. Choices: True, False. Whether the main visual container is visible to screenreaders (Text in the header and footer are always available to screenreaders.). Flourish type hint: boolean, defaults to None |
Arguments | Description |
---|---|
. | Returns the Flourish object |
text | Text. Fill in the text you want to annotate In the datasheet, you can write which parts of the text should be annotated. If you want to annotate a specific part of the text that occurs more than once, you can add identifiers to your text. For example, "Id like to annotate the word beautiful{beautiful-annotation}." Then, in the datasheet, you can write "beautiful-annotation" in the first column and the text to include in the annotation in the second column. Flourish type hint: html, defaults to NULL |
highlight_color | Highlight color. Flourish type hint: color, defaults to NULL |
layout_align | Align. Choices: center, start. Flourish type hint: string, defaults to NULL |
text_container_width | Width. Max width of text container. Flourish type hint: number, defaults to NULL |
text_font_size | Font size. In rems, a multiple of the pages base font size. Flourish type hint: number, defaults to NULL |
text_font_color | Text color. Flourish type hint: color, defaults to NULL |
text_font_color_highlighted | Text color (highlighted). Flourish type hint: color, defaults to NULL |
text_font_color_highlighted_contrast | Text color (highlighted). Flourish type hint: color, defaults to NULL |
text_highlight_type | Highlight type. Choices: handdrawn, background, text_color, underline. Flourish type hint: string, defaults to NULL |
text_highlight_handdrawn | Handdrawn type. Choices: circle, highlight, box, underline. Flourish type hint: string, defaults to NULL |
highlighted_stroke_end | Stroke end. Choices: round,Flourish type hint: string, defaults to NULL |
highlighted_stroke_amount | Iterations. Number of lines to draw. Flourish type hint: number, defaults to NULL |
highlighted_stroke_width | Thickness. Flourish type hint: number, defaults to NULL |
note_type | Mode. Choices: side-panel, inline. Flourish type hint: string, defaults to NULL |
note_visibility | Show notes. Choices: always, click. Flourish type hint: string, defaults to NULL |
note_font_size | Text size. Flourish type hint: number, defaults to NULL |
side_panel_width | Width. Max width of side panel. Flourish type hint: number, defaults to NULL |
note_font_color | Text color. Flourish type hint: color, defaults to NULL |
note_background_color | Background color. Flourish type hint: color, defaults to NULL |
note_custom_content | Note content. Use {{NOTE}} to show the annotation content. Use this setting to add prefixes, suffixes or additional HTML styling to your annotations. Flourish type hint: html, defaults to NULL |
note_mobile_mode | Mobile mode. Choices: side-panel, inline, overlay. Choose where to display the notes on smaller screens. Flourish type hint: string, defaults to NULL |
chart_layout_body_font | Main font. This font will apply to the whole graphic by default. You can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels. Flourish type hint: font, defaults to NULL |
chart_layout_font_color | Text color. This color will apply to the whole graphic by default, You can optionally change the color for individual text elements, in other settings panels. Flourish type hint: color, defaults to NULL |
chart_layout_background_color_enabled | Color. Choices: TRUE , FALSE . Flourish type hint: boolean, defaults to NULL |
chart_layout_background_image_enabled | Image. Choices: TRUE , FALSE . Flourish type hint: boolean, defaults to NULL |
chart_layout_background_color | Background color. Flourish type hint: color, defaults to NULL |
chart_layout_background_image_src | Image URL. Flourish type hint: url, defaults to NULL |
chart_layout_background_image_size | Size. Choices: cover, contain, auto, 100% 100%. Flourish type hint: string, defaults to NULL |
chart_layout_background_image_position | Position. Choices: top left, top center, top right, center left, center center, center right, bottom left, bottom center, bottom right. Flourish type hint: string, defaults to NULL |
chart_layout_max_width_target | Maximum width. Choices: none, wrapper, primary. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc). Flourish type hint: string, defaults to NULL |
chart_layout_max_width | Maximum width. Leave blank to stretch to container width. Flourish type hint: number, defaults to NULL |
chart_layout_max_width_align | Align. Choices: left, center, right. Flourish type hint: string, defaults to NULL |
chart_layout_layout_order | Layout order. Flourish type hint: string, defaults to NULL |
chart_layout_space_between_sections | Space between sections. Choices: 0.5, 1, 1.5, custom. Flourish type hint: string, defaults to NULL |
chart_layout_space_between_sections_custom | Custom. Flourish type hint: number, defaults to NULL |
chart_layout_margin_top | Top. Flourish type hint: number, defaults to NULL |
chart_layout_margin_right | Right. Flourish type hint: number, defaults to NULL |
chart_layout_margin_bottom | Bottom. Flourish type hint: number, defaults to NULL |
chart_layout_margin_left | Left. Flourish type hint: number, defaults to NULL |
chart_layout_border_enabled | Show borders around visualisation. Flourish type hint: boolean, defaults to NULL |
chart_layout_border_top_width | Top. Flourish type hint: number, defaults to NULL |
chart_layout_border_top_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_border_top_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_border_right_width | Right. Flourish type hint: number, defaults to NULL |
chart_layout_border_right_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_border_right_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_border_bottom_width | Bottom. Flourish type hint: number, defaults to NULL |
chart_layout_border_bottom_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_border_bottom_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_border_left_width | Left. Flourish type hint: number, defaults to NULL |
chart_layout_border_left_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_border_left_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_read_direction | Read direction. Choices: ltr, rtl. This will change the reading direction of the main text elements on the page. Its not possible to adjust this on all elements, such as axes. Note that when direction is set to right to left any alignment icons will be reversed. Flourish type hint: string, defaults to NULL |
chart_layout_font_size_mobile_small | Flourish type hint: number, defaults to NULL |
chart_layout_font_size_mobile_big | Flourish type hint: number, defaults to NULL |
chart_layout_font_size_tablet | Flourish type hint: number, defaults to NULL |
chart_layout_font_size_desktop | Flourish type hint: number, defaults to NULL |
chart_layout_font_size_big_screen | Flourish type hint: number, defaults to NULL |
chart_layout_breakpoint_mobile_small | Flourish type hint: number, defaults to NULL |
chart_layout_breakpoint_mobile_big | Flourish type hint: number, defaults to NULL |
chart_layout_breakpoint_tablet | Flourish type hint: number, defaults to NULL |
chart_layout_breakpoint_desktop | Flourish type hint: number, defaults to NULL |
chart_layout_breakpoint_big_screen | Flourish type hint: number, defaults to NULL |
chart_layout_header_align | Alignment. Choices: left, center, right. Flourish type hint: string, defaults to NULL |
chart_layout_title | Flourish type hint: html, defaults to NULL |
chart_layout_title_styling | Styling. Flourish type hint: boolean, defaults to NULL |
chart_layout_title_font | Title Font. Flourish type hint: font, defaults to NULL |
chart_layout_title_size | Size. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to NULL |
chart_layout_title_size_custom | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to NULL |
chart_layout_title_weight | Weight. Choices: bold, normal. Flourish type hint: string, defaults to NULL |
chart_layout_title_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_title_line_height | Line height. Flourish type hint: number, defaults to NULL |
chart_layout_title_space_above | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to NULL |
chart_layout_title_space_above_custom | Custom. Flourish type hint: number, defaults to NULL |
chart_layout_subtitle | Flourish type hint: html, defaults to NULL |
chart_layout_subtitle_styling | Styling. Flourish type hint: boolean, defaults to NULL |
chart_layout_subtitle_font | Subtitle Font. Flourish type hint: font, defaults to NULL |
chart_layout_subtitle_size | Size. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to NULL |
chart_layout_subtitle_size_custom | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to NULL |
chart_layout_subtitle_weight | Weight. Choices: bold, normal. Flourish type hint: string, defaults to NULL |
chart_layout_subtitle_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_subtitle_line_height | Line height. Flourish type hint: number, defaults to NULL |
chart_layout_subtitle_space_above | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to NULL |
chart_layout_subtitle_space_above_custom | Custom. Flourish type hint: number, defaults to NULL |
chart_layout_header_text | Flourish type hint: html, defaults to NULL |
chart_layout_header_text_styling | Styling. Flourish type hint: boolean, defaults to NULL |
chart_layout_header_text_size | Size. Choices: 1.2, 1.4, 1.6, custom. Flourish type hint: string, defaults to NULL |
chart_layout_header_text_size_custom | Custom. Specify a custom responsive font size in rems The best results will be with values between 1.2 and 3. Flourish type hint: number, defaults to NULL |
chart_layout_header_text_weight | Weight. Choices: bold, normal. Flourish type hint: string, defaults to NULL |
chart_layout_header_text_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_header_text_line_height | Line height. Flourish type hint: number, defaults to NULL |
chart_layout_header_text_space_above | Space above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to NULL |
chart_layout_header_text_space_above_custom | Custom. Flourish type hint: number, defaults to NULL |
chart_layout_header_border | Choices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to NULL |
chart_layout_header_border_width | Width. Flourish type hint: number, defaults to NULL |
chart_layout_header_border_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_header_border_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_header_border_space | Space. Space between border and header text. Flourish type hint: number, defaults to NULL |
chart_layout_header_logo_enabled | Choices: TRUE , FALSE . Flourish type hint: boolean, defaults to NULL |
chart_layout_header_logo_src | Image. Flourish type hint: url, defaults to NULL |
chart_layout_header_logo_alt | Alt text. Flourish type hint: string, defaults to NULL |
chart_layout_header_logo_link_url | Link. Flourish type hint: string, defaults to NULL |
chart_layout_header_logo_height | Height. Flourish type hint: number, defaults to NULL |
chart_layout_header_logo_align | Align. Choices: inside, outside. Align logo inside either the header or the main visualization container. Flourish type hint: string, defaults to NULL |
chart_layout_header_logo_position_inside | Position. Choices: top, left, right. Flourish type hint: string, defaults to NULL |
chart_layout_header_logo_position_outside | Position. Choices: left, right. Flourish type hint: string, defaults to NULL |
chart_layout_header_logo_margin_top | Top. Flourish type hint: number, defaults to NULL |
chart_layout_header_logo_margin_right | Right. Flourish type hint: number, defaults to NULL |
chart_layout_header_logo_margin_bottom | Bottom. Flourish type hint: number, defaults to NULL |
chart_layout_header_logo_margin_left | Left. Flourish type hint: number, defaults to NULL |
chart_layout_footer_align | Alignment. Choices: left, center, right, justify. Flourish type hint: string, defaults to NULL |
chart_layout_footer_text_size | Size. Flourish type hint: number, defaults to NULL |
chart_layout_footer_text_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_footer_styling | Advanced footer styles. Flourish type hint: boolean, defaults to NULL |
chart_layout_footer_font | Font. Flourish type hint: font, defaults to NULL |
chart_layout_footer_text_weight | Weight. Choices: bold, normal. Flourish type hint: string, defaults to NULL |
chart_layout_source_name | Source name. Flourish type hint: string, defaults to NULL |
chart_layout_source_url | Source url. Flourish type hint: string, defaults to NULL |
chart_layout_multiple_sources | Multiple sources. Flourish type hint: boolean, defaults to NULL |
chart_layout_source_name_2 | Source name. Flourish type hint: string, defaults to NULL |
chart_layout_source_url_2 | Source url. Flourish type hint: string, defaults to NULL |
chart_layout_source_name_3 | Source name. Flourish type hint: string, defaults to NULL |
chart_layout_source_url_3 | Source url. Flourish type hint: string, defaults to NULL |
chart_layout_source_label | Source label. Flourish type hint: string, defaults to NULL |
chart_layout_footer_note | Note. To add the time/date stamp of when the data was last updated add {{data_last_updated}} . For example, "Last updated at {{data_last_updated}} ". To customize the format, use the advanced options below. Flourish type hint: html, defaults to NULL |
chart_layout_footer_note_secondary | Note (secondary). The secondary note is placed below the source and primary note. To add the time/date stamp of when the data was last updated add {{data_last_updated}} . For example, "Last updated at {{data_last_updated}} ". To customize the format, use the advanced options below. Flourish type hint: html, defaults to NULL |
chart_layout_advanced_note_styling | Advanced. Flourish type hint: boolean, defaults to NULL |
chart_layout_footer_timestamp_format | Time/date stamp formatting. Choices: %H:%M:%S, %I:%M %p, %H:%M, %H:%M %p, %H:%M:%S, %d %b %Y, %H:%M, %d %b %Y, %H:%M, %d/%m/%Y, %H:%M, %m/%d/%Y, %H:%M, %d-%m-%Y, %H:%M, %m-%d-%Y, %d %b %Y, %m/%d/%Y, %d/%m/%Y, %m-%d-%Y, %d-%m-%Y, %Y-%m-%d, %Y-%m-%d %H:%M:%S. Flourish type hint: string, defaults to NULL |
chart_layout_footer_logo_enabled | Image. Choices: TRUE , FALSE . Flourish type hint: boolean, defaults to NULL |
chart_layout_footer_logo_src | Image. Flourish type hint: url, defaults to NULL |
chart_layout_footer_logo_src_light | Image (light version). If provided this version will be used whenever the background color is dark. Flourish type hint: hidden, defaults to NULL |
chart_layout_footer_logo_alt | Alt text. Flourish type hint: string, defaults to NULL |
chart_layout_footer_logo_link_url | Link. Flourish type hint: string, defaults to NULL |
chart_layout_footer_logo_height | Height. Flourish type hint: number, defaults to NULL |
chart_layout_footer_logo_margin | Margin. Flourish type hint: number, defaults to NULL |
chart_layout_footer_logo_order | Position. Choices: left, right. Flourish type hint: string, defaults to NULL |
chart_layout_footer_align_vertical | V. align. Choices: flex-start, center, flex-end. Flourish type hint: string, defaults to NULL |
chart_layout_footer_border | Choices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to NULL |
chart_layout_footer_border_width | Width. Flourish type hint: number, defaults to NULL |
chart_layout_footer_border_color | Color. Flourish type hint: color, defaults to NULL |
chart_layout_footer_border_style | Style. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to NULL |
chart_layout_footer_border_space | Space. Space between border and footer text. Flourish type hint: number, defaults to NULL |
chart_layout_screenreader_text_primary | Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. The line chart shows China consistently higher than the other countries since 1990. Do not replicate your title, since that will also be read by screenreaders. Flourish type hint: text, defaults to NULL |
chart_layout_screenreader_label | Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to screenreaders Added in the form of an "aria-label". Flourish type hint: string, defaults to NULL |
chart_layout_screenreader_hide_primary | Screenreader mode for main visual container. Choices: TRUE , FALSE . Whether the main visual container is visible to screenreaders (Text in the header and footer are always available to screenreaders.). Flourish type hint: boolean, defaults to NULL |