rendering

Documentation

Index

• Constants
• Variables
• type CSVOpts
• type Opts
• type RenderCSVResult
• type RenderResult
• type RenderType
• type RenderUser
• type RenderingService
  • func ProvideService(cfg *setting.Cfg, remoteCache *remotecache.RemoteCache, ...) (*RenderingService, error)
  • func (rs *RenderingService) GetRenderUser(key string) (*RenderUser, bool)
  • func (rs *RenderingService) IsAvailable() bool
  • func (rs *RenderingService) Render(ctx context.Context, opts Opts) (*RenderResult, error)
  • func (rs *RenderingService) RenderCSV(ctx context.Context, opts CSVOpts) (*RenderCSVResult, error)
  • func (rs *RenderingService) RenderErrorImage(theme Theme, err error) (*RenderResult, error)
  • func (rs *RenderingService) Run(ctx context.Context) error
  • func (rs *RenderingService) Version() string
• type Service
• type Theme

Constants

const ServiceName = "RenderingService"

Variables

var ErrConcurrentLimitReached = errors.New("rendering concurrent limit reached")

var ErrRenderUnavailable = errors.New("rendering plugin not available")

var ErrTimeout = errors.New("timeout error - you can set timeout in seconds with &timeout url parameter")

Types

type CSVOpts

type CSVOpts struct {
	Timeout         time.Duration
	OrgID           int64
	UserID          int64
	OrgRole         models.RoleType
	Path            string
	Encoding        string
	Timezone        string
	ConcurrentLimit int
	Headers         map[string][]string
}

type Opts

type Opts struct {
	Width             int
	Height            int
	Timeout           time.Duration
	OrgID             int64
	UserID            int64
	OrgRole           models.RoleType
	Path              string
	Encoding          string
	Timezone          string
	ConcurrentLimit   int
	DeviceScaleFactor float64
	Headers           map[string][]string
	Theme             Theme
}

type RenderCSVResult

type RenderCSVResult struct {
	FilePath string
	FileName string
}

type RenderResult

type RenderResult struct {
	FilePath string
}

type RenderType

type RenderType string

const (
	RenderCSV RenderType = "csv"
	RenderPNG RenderType = "png"
)

type RenderUser

type RenderUser struct {
	OrgID   int64
	UserID  int64
	OrgRole string
}

type RenderingService

type RenderingService struct {
	Cfg                   *setting.Cfg
	RemoteCacheService    *remotecache.RemoteCache
	RendererPluginManager plugins.RendererManager
	// contains filtered or unexported fields
}

func ProvideService

func ProvideService(cfg *setting.Cfg, remoteCache *remotecache.RemoteCache, rm plugins.RendererManager) (*RenderingService, error)

func (*RenderingService) GetRenderUser

func (rs *RenderingService) GetRenderUser(key string) (*RenderUser, bool)

func (*RenderingService) IsAvailable

func (rs *RenderingService) IsAvailable() bool

func (*RenderingService) Render

func (rs *RenderingService) Render(ctx context.Context, opts Opts) (*RenderResult, error)

func (*RenderingService) RenderCSV

func (rs *RenderingService) RenderCSV(ctx context.Context, opts CSVOpts) (*RenderCSVResult, error)

func (*RenderingService) RenderErrorImage

func (rs *RenderingService) RenderErrorImage(theme Theme, err error) (*RenderResult, error)

func (*RenderingService) Run

func (rs *RenderingService) Run(ctx context.Context) error

func (*RenderingService) Version

func (rs *RenderingService) Version() string

type Service

type Service interface {
	IsAvailable() bool
	Version() string
	Render(ctx context.Context, opts Opts) (*RenderResult, error)
	RenderCSV(ctx context.Context, opts CSVOpts) (*RenderCSVResult, error)
	RenderErrorImage(theme Theme, error error) (*RenderResult, error)
	GetRenderUser(key string) (*RenderUser, bool)
}

type Theme

type Theme string

const (
	ThemeLight Theme = "light"
	ThemeDark  Theme = "dark"
)