rendering

Documentation

Index

• Variables
• type Opts
• type RenderResult
• type RenderUser
• type RenderingService
  • func (rs *RenderingService) GetRenderUser(key string) (*RenderUser, bool)
  • func (rs *RenderingService) Init() error
  • func (rs *RenderingService) IsAvailable() bool
  • func (rs *RenderingService) Render(ctx context.Context, opts Opts) (*RenderResult, error)
  • func (rs *RenderingService) RenderErrorImage(err error) (*RenderResult, error)
  • func (rs *RenderingService) Run(ctx context.Context) error
• type Service

Variables

var ErrNoRenderer = errors.New("No renderer plugin found nor is an external render server configured")

var ErrPhantomJSNotInstalled = errors.New("PhantomJS executable not found")

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

Types

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
}

type RenderResult

type RenderResult struct {
	FilePath string
}

type RenderUser

type RenderUser struct {
	OrgID   int64
	UserID  int64
	OrgRole string
}

type RenderingService

type RenderingService struct {
	Cfg                *setting.Cfg             `inject:""`
	RemoteCacheService *remotecache.RemoteCache `inject:""`
	// contains filtered or unexported fields
}

func (*RenderingService) GetRenderUser

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

func (*RenderingService) Init

func (rs *RenderingService) Init() error

func (*RenderingService) IsAvailable

func (rs *RenderingService) IsAvailable() bool

func (*RenderingService) Render

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

func (*RenderingService) RenderErrorImage

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

func (*RenderingService) Run

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

type Service

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