Set number ticker chart details

def set_number_ticker_details(
self,
mode: str = None,
number_start: float = None,
number: float = None,
custom_template: Union[list, str] = None,
font_unit: str = None,
font_size: float = None,
text_color: str = None,
font_weight: str = None,
line_height: float = None,
duration: float = None,
easing: str = None,
chart_number_localization_input_decimal_separator: str = None,
chart_number_localization_output_separators: str = None,
value_format_prefix: str = None,
value_format_suffix: str = None,
value_format_n_dec: float = None,
value_format_advanced: bool = None,
value_format_negative_sign: str = None,
value_format_strip_zeros: bool = None,
value_format_strip_separator: bool = None,
value_format_transform_labels: bool = None,
value_format_transform: str = None,
value_format_multiply_divide_constant: float = None,
value_format_exponentiate_constant: float = 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
ArgumentsType hintDescription
selfFlourishReturns the Flourish object
modestr, optionalChoices: simple, custom. Flourish type hint: string, defaults to None
number_startfloat, optionalTick from. Flourish type hint: number, defaults to None
numberfloat, optionalTick to. Flourish type hint: number, defaults to None
custom_templateUnion[list, str], optionalText and {{numbers}}. Put numbers to tick in double braces, e.g. {{1000}} to tick from 0 to 1000, or {{-1000/1000}} to count from -1000 to 1000. You can also use markdown styling, e.g. bold and italic or custom HTMLFlourish type hint: text, defaults to None
font_unitstr, optionalFont size mode. Choices: vw, rem. When set to Scale with page, the text will always take up the same proportion of the page width, on any page size (e.g. mobile or desktop) When set to Default the text will be scaled responsively in the same way as other text components, such as the header text. Flourish type hint: string, defaults to None
font_sizefloat, optionalFont size. Flourish type hint: number, defaults to None
text_colorstr, optionalColor. Flourish type hint: color, defaults to None
font_weightstr, optionalFont weight. Choices: normal, bold. Flourish type hint: string, defaults to None
line_heightfloat, optionalLine height. Flourish type hint: number, defaults to None
durationfloat, optionalDuration. How many seconds you want the animation to last for. Flourish type hint: number, defaults to None
easingstr, optionalTick rate. Choices: constant, speed_up, slow_down, fast_slow_fast. Flourish type hint: string, defaults to None
chart_number_localization_input_decimal_separatorstr, optionalDecimal separator in data sheet. Choices: ., ,. Used for interpreting your data. Only change if data is not displaying on the chart as expected. Flourish type hint: string, defaults to None
chart_number_localization_output_separatorsstr, optionalNumber format to display. Choices: ,., .,, ., ,, ., ,. How the numbers should appear on chart labels. Flourish type hint: string, defaults to None
value_format_prefixstr, optionalPrefix. Text to place in front of number. Flourish type hint: string, defaults to None
value_format_suffixstr, optionalSuffix. Text to place after number. Flourish type hint: string, defaults to None
value_format_n_decfloat, optionalDecimal places. Enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred. Flourish type hint: number, defaults to None
value_format_advancedbool, optionalAdvanced. Flourish type hint: boolean, defaults to None
value_format_negative_signstr, optionalStyling of negative numbers. Choices: -$nk, $-nk, ($nk), $(n)k, none. Flourish type hint: string, defaults to None
value_format_strip_zerosbool, optionalRemove trailing zeros. Flourish type hint: boolean, defaults to None
value_format_strip_separatorbool, optionalHide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. 1,234 rather than 1234. Flourish type hint: boolean, defaults to None
value_format_transform_labelsbool, optionalMultiply/divide values. Flourish type hint: boolean, defaults to None
value_format_transformstr, optionalChoices: multiply, divide, exponentiate. Flourish type hint: string, defaults to None
value_format_multiply_divide_constantfloat, optionalFlourish type hint: number, defaults to None
value_format_exponentiate_constantfloat, optionalFlourish type hint: number, defaults to None
chart_layout_body_fontstr, optionalMain 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_colorstr, optionalText 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_enabledbool, optionalColor. Choices: True, False. Flourish type hint: boolean, defaults to None
chart_layout_background_image_enabledbool, optionalImage. Choices: True, False. Flourish type hint: boolean, defaults to None
chart_layout_background_colorstr, optionalBackground color. Flourish type hint: color, defaults to None
chart_layout_background_image_srcstr, optionalImage URL. Flourish type hint: url, defaults to None
chart_layout_background_image_sizestr, optionalSize. Choices: cover, contain, auto, 100% 100%. Flourish type hint: string, defaults to None
chart_layout_background_image_positionstr, optionalPosition. 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_targetstr, optionalMaximum 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_widthfloat, optionalMaximum width. Leave blank to stretch to container width. Flourish type hint: number, defaults to None
chart_layout_max_width_alignstr, optionalAlign. Choices: left, center, right. Flourish type hint: string, defaults to None
chart_layout_layout_orderstr, optionalLayout order. Flourish type hint: string, defaults to None
chart_layout_space_between_sectionsstr, optionalSpace between sections. Choices: 0.5, 1, 1.5, custom. Flourish type hint: string, defaults to None
chart_layout_space_between_sections_customfloat, optionalCustom. Flourish type hint: number, defaults to None
chart_layout_margin_topfloat, optionalTop. Flourish type hint: number, defaults to None
chart_layout_margin_rightfloat, optionalRight. Flourish type hint: number, defaults to None
chart_layout_margin_bottomfloat, optionalBottom. Flourish type hint: number, defaults to None
chart_layout_margin_leftfloat, optionalLeft. Flourish type hint: number, defaults to None
chart_layout_border_enabledbool, optionalShow borders around visualisation. Flourish type hint: boolean, defaults to None
chart_layout_border_top_widthfloat, optionalTop. Flourish type hint: number, defaults to None
chart_layout_border_top_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_border_top_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_border_right_widthfloat, optionalRight. Flourish type hint: number, defaults to None
chart_layout_border_right_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_border_right_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_border_bottom_widthfloat, optionalBottom. Flourish type hint: number, defaults to None
chart_layout_border_bottom_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_border_bottom_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_border_left_widthfloat, optionalLeft. Flourish type hint: number, defaults to None
chart_layout_border_left_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_border_left_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_read_directionstr, optionalRead 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_smallfloat, optionalFlourish type hint: number, defaults to None
chart_layout_font_size_mobile_bigfloat, optionalFlourish type hint: number, defaults to None
chart_layout_font_size_tabletfloat, optionalFlourish type hint: number, defaults to None
chart_layout_font_size_desktopfloat, optionalFlourish type hint: number, defaults to None
chart_layout_font_size_big_screenfloat, optionalFlourish type hint: number, defaults to None
chart_layout_breakpoint_mobile_smallfloat, optionalFlourish type hint: number, defaults to None
chart_layout_breakpoint_mobile_bigfloat, optionalFlourish type hint: number, defaults to None
chart_layout_breakpoint_tabletfloat, optionalFlourish type hint: number, defaults to None
chart_layout_breakpoint_desktopfloat, optionalFlourish type hint: number, defaults to None
chart_layout_breakpoint_big_screenfloat, optionalFlourish type hint: number, defaults to None
chart_layout_header_alignstr, optionalAlignment. Choices: left, center, right. Flourish type hint: string, defaults to None
chart_layout_titleUnion[list, str], optionalFlourish type hint: html, defaults to None
chart_layout_title_stylingbool, optionalStyling. Flourish type hint: boolean, defaults to None
chart_layout_title_fontstr, optionalTitle Font. Flourish type hint: font, defaults to None
chart_layout_title_sizestr, optionalSize. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to None
chart_layout_title_size_customfloat, optionalCustom. 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_weightstr, optionalWeight. Choices: bold, normal. Flourish type hint: string, defaults to None
chart_layout_title_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_title_line_heightfloat, optionalLine height. Flourish type hint: number, defaults to None
chart_layout_title_space_abovestr, optionalSpace above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None
chart_layout_title_space_above_customfloat, optionalCustom. Flourish type hint: number, defaults to None
chart_layout_subtitleUnion[list, str], optionalFlourish type hint: html, defaults to None
chart_layout_subtitle_stylingbool, optionalStyling. Flourish type hint: boolean, defaults to None
chart_layout_subtitle_fontstr, optionalSubtitle Font. Flourish type hint: font, defaults to None
chart_layout_subtitle_sizestr, optionalSize. Choices: 1.4, 1.6, 2, custom. Flourish type hint: string, defaults to None
chart_layout_subtitle_size_customfloat, optionalCustom. 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_weightstr, optionalWeight. Choices: bold, normal. Flourish type hint: string, defaults to None
chart_layout_subtitle_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_subtitle_line_heightfloat, optionalLine height. Flourish type hint: number, defaults to None
chart_layout_subtitle_space_abovestr, optionalSpace above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None
chart_layout_subtitle_space_above_customfloat, optionalCustom. Flourish type hint: number, defaults to None
chart_layout_header_textUnion[list, str], optionalFlourish type hint: html, defaults to None
chart_layout_header_text_stylingbool, optionalStyling. Flourish type hint: boolean, defaults to None
chart_layout_header_text_sizestr, optionalSize. Choices: 1.2, 1.4, 1.6, custom. Flourish type hint: string, defaults to None
chart_layout_header_text_size_customfloat, optionalCustom. 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_weightstr, optionalWeight. Choices: bold, normal. Flourish type hint: string, defaults to None
chart_layout_header_text_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_header_text_line_heightfloat, optionalLine height. Flourish type hint: number, defaults to None
chart_layout_header_text_space_abovestr, optionalSpace above. Choices: 0, 0.5, 1, custom. Flourish type hint: string, defaults to None
chart_layout_header_text_space_above_customfloat, optionalCustom. Flourish type hint: number, defaults to None
chart_layout_header_borderstr, optionalChoices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to None
chart_layout_header_border_widthfloat, optionalWidth. Flourish type hint: number, defaults to None
chart_layout_header_border_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_header_border_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_header_border_spacefloat, optionalSpace. Space between border and header text. Flourish type hint: number, defaults to None
chart_layout_header_logo_enabledbool, optionalChoices: True, False. Flourish type hint: boolean, defaults to None
chart_layout_header_logo_srcstr, optionalImage. Flourish type hint: url, defaults to None
chart_layout_header_logo_altstr, optionalAlt text. Flourish type hint: string, defaults to None
chart_layout_header_logo_link_urlstr, optionalLink. Flourish type hint: string, defaults to None
chart_layout_header_logo_heightfloat, optionalHeight. Flourish type hint: number, defaults to None
chart_layout_header_logo_alignstr, optionalAlign. 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_insidestr, optionalPosition. Choices: top, left, right. Flourish type hint: string, defaults to None
chart_layout_header_logo_position_outsidestr, optionalPosition. Choices: left, right. Flourish type hint: string, defaults to None
chart_layout_header_logo_margin_topfloat, optionalTop. Flourish type hint: number, defaults to None
chart_layout_header_logo_margin_rightfloat, optionalRight. Flourish type hint: number, defaults to None
chart_layout_header_logo_margin_bottomfloat, optionalBottom. Flourish type hint: number, defaults to None
chart_layout_header_logo_margin_leftfloat, optionalLeft. Flourish type hint: number, defaults to None
chart_layout_footer_alignstr, optionalAlignment. Choices: left, center, right, justify. Flourish type hint: string, defaults to None
chart_layout_footer_text_sizefloat, optionalSize. Flourish type hint: number, defaults to None
chart_layout_footer_text_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_footer_stylingbool, optionalAdvanced footer styles. Flourish type hint: boolean, defaults to None
chart_layout_footer_fontstr, optionalFont. Flourish type hint: font, defaults to None
chart_layout_footer_text_weightstr, optionalWeight. Choices: bold, normal. Flourish type hint: string, defaults to None
chart_layout_source_namestr, optionalSource name. Flourish type hint: string, defaults to None
chart_layout_source_urlstr, optionalSource url. Flourish type hint: string, defaults to None
chart_layout_multiple_sourcesbool, optionalMultiple sources. Flourish type hint: boolean, defaults to None
chart_layout_source_name_2str, optionalSource name. Flourish type hint: string, defaults to None
chart_layout_source_url_2str, optionalSource url. Flourish type hint: string, defaults to None
chart_layout_source_name_3str, optionalSource name. Flourish type hint: string, defaults to None
chart_layout_source_url_3str, optionalSource url. Flourish type hint: string, defaults to None
chart_layout_source_labelstr, optionalSource label. Flourish type hint: string, defaults to None
chart_layout_footer_noteUnion[list, str], optionalNote. 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_secondaryUnion[list, str], optionalNote (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_stylingbool, optionalAdvanced. Flourish type hint: boolean, defaults to None
chart_layout_footer_timestamp_formatstr, optionalTime/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_enabledbool, optionalImage. Choices: True, False. Flourish type hint: boolean, defaults to None
chart_layout_footer_logo_srcstr, optionalImage. Flourish type hint: url, defaults to None
chart_layout_footer_logo_src_lightstr, optionalImage (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_altstr, optionalAlt text. Flourish type hint: string, defaults to None
chart_layout_footer_logo_link_urlstr, optionalLink. Flourish type hint: string, defaults to None
chart_layout_footer_logo_heightfloat, optionalHeight. Flourish type hint: number, defaults to None
chart_layout_footer_logo_marginfloat, optionalMargin. Flourish type hint: number, defaults to None
chart_layout_footer_logo_orderstr, optionalPosition. Choices: left, right. Flourish type hint: string, defaults to None
chart_layout_footer_align_verticalstr, optionalV. align. Choices: flex-start, center, flex-end. Flourish type hint: string, defaults to None
chart_layout_footer_borderstr, optionalChoices: top, bottom, top_and_bottom, none. Flourish type hint: string, defaults to None
chart_layout_footer_border_widthfloat, optionalWidth. Flourish type hint: number, defaults to None
chart_layout_footer_border_colorstr, optionalColor. Flourish type hint: color, defaults to None
chart_layout_footer_border_stylestr, optionalStyle. Choices: solid, dashed, dotted. Flourish type hint: string, defaults to None
chart_layout_footer_border_spacefloat, optionalSpace. Space between border and footer text. Flourish type hint: number, defaults to None
chart_layout_screenreader_text_primaryUnion[list, str], optionalScreenreader 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_labelstr, optionalScreenreader 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_primarybool, optionalScreenreader 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