set_countdown_details: Set countdown chart details

In flourishcharts: 'Flourish' for 'R' and 'Python'

Set countdown chart details

Description

Set countdown chart details

Usage

set_countdown_details(
  .,
  date_day = NULL,
  date_month = NULL,
  date_year = NULL,
  date_hour = NULL,
  date_minute = NULL,
  date_second = NULL,
  before_content_mode = NULL,
  before_content_custom = NULL,
  after_content_mode = NULL,
  after_content_custom = NULL,
  countdown_size = NULL,
  countdown_color = NULL,
  countdown_weight = 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
)

Arguments

.	The prior Flourish object. No need to specify name if piping graph as the graph will take the first argument (i.e. the prior existing graph).
date_day	Day. Flourish type hint: number, defaults to NULL
date_month	Month. Flourish type hint: number, defaults to NULL
date_year	Year. If your date is in the future, the tool will count down to it If its in the past, the tool will count up, showing the number of days that have passed since the date. Flourish type hint: number, defaults to NULL
date_hour	Hour. 0 to 23. Flourish type hint: number, defaults to NULL
date_minute	Minute. Flourish type hint: number, defaults to NULL
date_second	Second. Flourish type hint: number, defaults to NULL
before_content_mode	Text mode. Choices: auto, custom. Displays while counting down to the specified time/date. Flourish type hint: string, defaults to NULL
before_content_custom	Custom text before date/time reached. Can include any text or HTML Use {{d}} for days, {{h}} for hours, {{m}} for minutes and {{s}} for seconds. Flourish type hint: text, defaults to NULL
after_content_mode	Text mode. Choices: auto, custom. Displays while counting upwards after the specified time/date. Flourish type hint: string, defaults to NULL
after_content_custom	Custom text after date/time reached. Can include any text or HTML Use {{d}} for days, {{h}} for hours, {{m}} for minutes and {{s}} for seconds. Flourish type hint: text, defaults to NULL
countdown_size	Size. Measured in vw (percentage of view window). This makes sure the countdown always scales with the page. Flourish type hint: number, defaults to NULL
countdown_color	Color. Flourish type hint: color, defaults to NULL
countdown_weight	Weight. Choices: 400, 600. 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

Value

A Flourish chart

Examples

try(
  flourish(chart_type = "countdown", api_key = Sys.getenv("FLOURISH_API_KEY")) |> 
  set_countdown_details()
)

flourishcharts documentation built on Oct. 30, 2024, 9:07 a.m.