Package io.jmix.charts.model.chart

Interface FunnelChartModel<T extends FunnelChartModel>

All Superinterfaces:
ChartModel<T>, HasColors<T>, HasMargins<T>, HasStartEffect<T>, SlicedChartModel<T>
All Known Subinterfaces:
FunnelChart
All Known Implementing Classes:
FunnelChartImpl, FunnelChartModelImpl
public interface FunnelChartModel<T extends FunnelChartModel> extends SlicedChartModel<T>

  • Method Details

    • getBalloonText

      String getBalloonText()
      Returns:
      balloon text

    • setBalloonText

      @StudioProperty(defaultValue="[[title]]:[[value]]\n[[description]]") T setBalloonText(String balloonText)
      Sets balloon text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]]. Also can be used fields in the chart such as titleField, valueField etc. Fields that not used in the chart can be added by using additionalFields. HTML tags can also be used. If not set the default value is "[[title]]:[[value]]\n[[description]]".
      Parameters:
      balloonText - balloon text string
      Returns:
      funnel chart model

    • getBaseWidth

      String getBaseWidth()
      Returns:
      width of a base (first slice) of a chart

    • setBaseWidth

      @StudioProperty(defaultValue="100%") T setBaseWidth(String baseWidth)
      Sets width of a base (first slice) of a chart. 100% means it will occupy all available space. If not set the default value is 100%.
      Parameters:
      baseWidth - the base width
      Returns:
      funnel chart model

    • getLabelPosition

      LabelPosition getLabelPosition()
      Returns:
      label position

    • setLabelPosition

      @StudioProperty(type=ENUMERATION, defaultValue="CENTER") T setLabelPosition(LabelPosition labelPosition)
      Specifies where labels should be placed. Allowed values are left, center, right. If you set left or right, you should increase left or right margin in order labels to be visible. If not set the default value is CENTER.
      Parameters:
      labelPosition - the label position
      Returns:
      funnel chart model

    • getLabelText

      String getLabelText()
      Returns:
      label text

    • setLabelText

      @StudioProperty(defaultValue="[[title]]: [[value]]") T setLabelText(String labelText)
      Sets label text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]]. Also can be used fields in the chart such as titleField, valueField etc. Fields that not used in the chart can be added by using additionalFields. If not set the default value is "[[title]]: [[value]]".
      Parameters:
      labelText - label text string
      Returns:
      funnel chart model

    • getNeckHeight

      String getNeckHeight()
      Returns:
      height of a funnel neck

    • setNeckHeight

      @StudioProperty(defaultValue="0") T setNeckHeight(String neckHeight)
      Sets height of a funnel neck. If default value, zero is used, the funnel won't have neck at all, which will make it look like pyramid. If not set the default value is "0".
      Parameters:
      neckHeight - the neck height
      Returns:
      funnel chart model

    • getNeckWidth

      String getNeckWidth()
      Returns:
      width of a funnel neck

    • setNeckWidth

      @StudioProperty(defaultValue="0") T setNeckWidth(String neckWidth)
      Sets width of a funnel neck. If default value, zero is used, the funnel won't have neck at all, which will make it look like pyramid. If not set the default value is "0".
      Parameters:
      neckWidth - the neck width
      Returns:
      funnel chart model

    • getPullDistance

      String getPullDistance()
      Returns:
      pull distance

    • setPullDistance

      @StudioProperty(defaultValue="30") T setPullDistance(String pullDistance)
      Sets the distance by which slice should be pulled when user clicks on it. If not set the default value is 30.
      Parameters:
      pullDistance - the pull distance
      Returns:
      funnel chart model

    • getStartX

      Integer getStartX()
      Returns:
      initial X coordinate of slices

    • setStartX

      @StudioProperty(defaultValue="0") T setStartX(Integer startX)
      Sets initial X coordinate of slices. They will animate to the final X position from this one. If not set the default value is 0.
      Parameters:
      startX - the start X
      Returns:
      funnel chart model

    • getStartY

      Integer getStartY()
      Returns:
      initial Y coordinate of slices

    • setStartY

      @StudioProperty(defaultValue="0") T setStartY(Integer startY)
      Sets initial y coordinate of slices. They will animate to the final y position from this one. If not set the default value is 0.
      Parameters:
      startY - the start Y
      Returns:
      funnel chart model

    • getValueRepresents

      FunnelValueRepresentation getValueRepresents()
      Returns:
      value represents

    • setValueRepresents

      @StudioProperty(type=ENUMERATION, defaultValue="HEIGHT") T setValueRepresents(FunnelValueRepresentation valueRepresents)
      Sets the value represents. By default, the height of a slice represents it's value. Set this property to "area" if you want the area of a slice to represent value. If not set the default value is HEIGHT.
      Parameters:
      valueRepresents - the value represents
      Returns:
      funnel chart model

    • getRotate

      Boolean getRotate()
      Returns:
      true if rotate is enabled

    • setRotate

      @StudioProperty(defaultValue="false") T setRotate(Boolean rotate)
      If rotate is set to true, the funnel will be rotated and will became a pyramid. If not set the default value is false.
      Parameters:
      rotate - rotate option
      Returns:
      funnel chart model

    • getAngle

      Integer getAngle()
      Returns:
      the angle of the 3D part of the chart

    • setAngle

      @StudioProperty(defaultValue="0") T setAngle(Integer angle)
      Sets the angle of the 3D part of the chart. This creates a 3D effect (if the depth3D is greater than 0). If not set the default value is 0.
      Parameters:
      angle - the angle
      Returns:
      funnel chart model

    • getDepth3D

      Integer getDepth3D()
      Returns:
      the depth of funnel/pyramid

    • setDepth3D

      @StudioProperty T setDepth3D(Integer depth3D)
      Sets the depth of funnel/pyramid. Set angle to greater than 0 value in order this to work. Note, neckHeight/neckWidth will become 0 if you set these properties to bigger than 0 values.
      Parameters:
      depth3D - the depth 3D
      Returns:
      funnel chart model