Commit c478f696 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update property/argument documentation

parent 793c1aba

CMakeLists.txt

+2 −2
Original line number Diff line number Diff line
@@ -81,7 +81,7 @@ foreach(example_test_path ${example_test_files}) 
  add_test(

      NAME test_example_${example_test_name}_svg

      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}

      COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/spec/test_runner.sh ${CMAKE_CURRENT_BINARY_DIR}/fviz ${example_test_path} ${CMAKE_CURRENT_BINARY_DIR}/example_${example_test_name}.svg ${example_test_srcdir}/${example_test_name}.svg)

      COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/spec/test_runner.sh ${CMAKE_CURRENT_BINARY_DIR}/fviz ${example_test_name} ${example_test_srcdir} ${CMAKE_CURRENT_BINARY_DIR})

endforeach()



file(GLOB doc_test_files "manual/figures/*.fvz")
@@ -91,5 +91,5 @@ foreach(doc_test_path ${doc_test_files}) 
  add_test(

      NAME test_doc_${doc_test_name}_svg

      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}

      COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/spec/test_runner.sh ${CMAKE_CURRENT_BINARY_DIR}/fviz ${doc_test_path} ${CMAKE_CURRENT_BINARY_DIR}/figure_${doc_test_name}.svg ${doc_test_srcdir}/${doc_test_name}.svg)

      COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/spec/test_runner.sh ${CMAKE_CURRENT_BINARY_DIR}/fviz ${doc_test_name} ${doc_test_srcdir} ${CMAKE_CURRENT_BINARY_DIR})

endforeach()

examples/charts/scatterplot_basic.fvz

0 → 100644
+13 −0
Original line number Diff line number Diff line 
(chart/scatterplot

    data-x (csv tests/testdata/gauss2d.csv x)

    data-y (csv tests/testdata/gauss2d.csv y)

    axes (bottom left)

    grid (color #fff)

    legend (items ("Random Data"))

    ticks-y (subdivide 5)

    background #eee

    border none

    range-x-min 0

    range-x-max 400

    range-y-min 0

    range-y-max 200)

examples/charts/scatterplot_basic.svg

0 → 100644
+1059 −0

File added.

Preview size limit exceeded, changes collapsed.

examples/examples.yaml

+57 −55
Original line number Diff line number Diff line 
- section: Basic Charts

  files:

    - file: pointcharts/simple_scatter

      desc: A simple scatter plot.



- section: Line Charts

  files:

    - file: linecharts/simple_timeseries

      desc: A simple line chart.



    - file: linecharts/lines_with_points

      desc: A simple line chart with points and a legend.



    - file: linecharts/lines_with_labels

      desc: A line chart with labels.



    - file: linecharts/irregular_data

      desc: Plotting two series with unaligned data points.





- section: Bar Charts

  files:

    - file: barcharts/bars_with_labels

      desc: A vertical bar chart with labels.



    - file: barcharts/horizontal_bars

      desc: A simple horizontal bar chart.



    - file: barcharts/horizontal_ranges

      desc: A grouped, "floating" horizontal bar chart



    - file: barcharts/vertical_ranges

      desc: A grouped, "floating" vertical bar chart



    - file: barcharts/barsandlines

      desc: A bar chart and a line element.



##- section: Basic Charts

##  files:

##    - file: pointcharts/simple_scatter

##      desc: A simple scatter plot.

##

##- section: Line Charts

##  files:

##    - file: linecharts/simple_timeseries

##      desc: A simple line chart.

##

##    - file: linecharts/lines_with_points

##      desc: A simple line chart with points and a legend.

##

##    - file: linecharts/lines_with_labels

##      desc: A line chart with labels.

##

##    - file: linecharts/irregular_data

##      desc: Plotting two series with unaligned data points.

##

##

##- section: Bar Charts

##  files:

##    - file: barcharts/bars_with_labels

##      desc: A vertical bar chart with labels.

##

##    - file: barcharts/horizontal_bars

##      desc: A simple horizontal bar chart.

##

##    - file: barcharts/horizontal_ranges

##      desc: A grouped, "floating" horizontal bar chart

##

##    - file: barcharts/vertical_ranges

##      desc: A grouped, "floating" vertical bar chart

##

##    - file: barcharts/barsandlines

##      desc: A bar chart and a line element.

##

- section: Scatter Plots

  files:



    - file: pointcharts/pointchart_with_labels

      desc: A scatter plot with labelled data points.



- section: Area Charts

  files:

    - file: areacharts/simple_area

      desc: A simple area chart.



    - file: areacharts/area_ranges

      desc: A "range" area chart



- section: Other

  files:

    - file: other/demo

      desc: A collection of examples generated with fviz

    - file: other/demo2

      desc: A collection of examples generated with fviz
 
    - file: charts/scatterplot_basic

      desc: A simple scatter plot of random data.

##

##    - file: pointcharts/pointchart_with_labels

##      desc: A scatter plot with labelled data points.

##

##- section: Area Charts

##  files:

##    - file: areacharts/simple_area

##      desc: A simple area chart.

##

##    - file: areacharts/area_ranges

##      desc: A "range" area chart

##

##- section: Other

##  files:

##    - file: other/demo

##      desc: A collection of examples generated with fviz

##    - file: other/demo2

##      desc: A collection of examples generated with fviz

extra/web/build.sh

+0 −1
Original line number Diff line number Diff line
@@ -18,7 +18,6 @@ cd "$(dirname "$0")/../.." 
cp extra/web/documentation.css "${output_dir}"

cp extra/web/redirects.txt "${output_dir}/_redirects"

cp extra/web/favicon.ico "${output_dir}"

cp extra/logo.png "${output_dir}"

mkdir -p "${output_dir}/documentation/figures"

cp manual/figures/*.svg "${output_dir}/documentation/figures/"

./extra/web/build_api_reference.py

CRA Git | Maintained and supported by SUSTech CRA and CCSE