Initialization

Before composing anything, the html file needs to be initialize through initfunction.

Function
init(filename, title, basetheme, charttheme, icon)

Example
import piesparrow as ps
ps.init(filename = 'helloWorld', title = 'My Hello World Page', basetheme = ps.light, charttheme =p s.sparrow_light, icon = True)

Themes

Color themes can be defined as piesparrow variable in the parameter ofinit(basetheme,charttheme)function.

Function
init(filename, title, basetheme, charttheme, icon)

Grids

Grids are composed of rows and column, each row can contain a minimum of 1 and maximum of 5 columns. Unlimited number of rows can be added

Typography

Beside writing text without any function will result in text being displayed, four different heading sizes starting from h1(biggest) to h4(smallest) can be called. pcan be called for paragraph texts and boldcan be called for strong text.

Function
h1(txt)
h2(txt)
h3(txt)
h4(txt)
p(txt)
bold(txt)

Example
import piesparrow as ps

ps.row(
  ps.h1('This is H1 Text')
+ ps.h2('This is H2 Text')
+ ps.h3('This is H3 Text')
+ ps.h4('This is H4 Text')
+ ps.p('This is paragraph Text')
+ ps.bold('This is bold text')
+ ps.p('This is '+ps.bold('inline bold')+'text')
)

Images

Images can be displayed by calling img.

Function
img(path, height, width)

Example
import piesparrow as ps

ps.row(
  ps.img(path='images/logo.png', height=100, width-100)
)

Links

Links can be displayed by calling link.

Function
link(target,label)

Example
import piesparrow as ps

ps.row(
  ps.link(target='https://piesparrow.com', label='home')
)

Datafames

Pandas data frames can be beautifully displaye by callingtable.

Function
table(df)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.table(df='data')
)

Charts

Bar Chart

Bar Charts can be created by calling chartfunction and declaring type parameter as 'bar'

Function
chart(title, df, columns, xcolumn, xaxistype, type, datalabels, zoom, legend, legendposition, grid, xlabel, ylabel, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.chart(
  title = 'barchart1',
  df = data,
  columns = ['Months','Data 1'],
  xcolumn = 'Months',
  type = 'bar',
  )
)

Line Chart

Line Charts can be created by calling chartfunction and declaring type parameter as 'line'

Function
chart(title, df, columns, xcolumn, xaxistype, type, datalabels, zoom, legend, legendposition, grid, xlabel, ylabel, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.chart(
  title = 'linechart1',
  df = data,
  columns = ['Months','Data 1'],
  xcolumn = 'Months',
  type = 'line',
  )
)

Spline Chart

Spline Charts can be created by calling chartfunction and declaring type parameter as 'spline'

Function
chart(title, df, columns, xcolumn, xaxistype, type, datalabels, zoom, legend, legendposition, grid, xlabel, ylabel, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.chart(
  title = 'splinechart1',
  df = data,
  columns = ['Months','Data 1'],
  xcolumn = 'Months',
  type = 'spline',
  )
)

Area Chart

Area Charts can be created by calling chartfunction and declaring type parameter as 'area'

Function
chart(title, df, columns, xcolumn, xaxistype, type, datalabels, zoom, legend, legendposition, grid, xlabel, ylabel, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.chart(
  title = 'areachart1',
  df = data,
  columns = ['Months','Data 1'],
  xcolumn = 'Months',
  type = 'area',
  )
)

Area Spline Chart

Area Spline Charts can be created by calling chartfunction and declaring type parameter as 'area-spline'

Function
chart(title, df, columns, xcolumn, xaxistype, type, datalabels, zoom, legend, legendposition, grid, xlabel, ylabel, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.chart(
  title = 'areasplinechart1',
  df = data,
  columns = ['Months','Data 1'],
  xcolumn = 'Months',
  type = 'area-spline',
  )
)

Pie Chart

Pie Charts can be created by calling piefunction.

Function
pie(title, df, columns, legend, legendposition, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv')
ps.row(
  ps.pie(
  title = 'piechart1',
  df = data,
  columns = ['Data 1', 'Data 2', 'Data 3', 'Data 4'],
  )
)

Donut Chart

Donut Charts can be created by calling donutfunction.

Function
donut(title, df, columns, legend, legendposition, height)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.donut(
  title = 'donutchart1',
  df = data,
  columns = ['Data 1', 'Data 2', 'Data 3', 'Data 4'],
  )
)

Gauge

Gauge can be created by calling gaugefunction.

Function
gauge(title, label, value, legend, legendposition,color, height)

Example
import piesparrow as ps
x = 60
ps.row(
  ps.gauge(
  title = 'gauge1',
  label = 'progress',
  value = x,
  color = '#127881'
)

KPI

KPI card can be created by calling kpifunction. It workby dispalying last row value in dataframe and difference of last and second last value as delta in positive or negative.

Function
kpi(df, column)

Example
import piesparrow as ps
import pandas as pd

data = pd.read_csv('mock_data.csv)
ps.row(
  ps.kpi(
  df = data,
  column = 'Data 1',
  )
)