CompanyAnalyticBoard extends Base
Class AnalyticBoard
Table of Contents
Constants
- REPORT_GUID = 'company_widget'
Methods
- __construct() : mixed
- addButton() : mixed
- addFeedbackButton() : mixed
- getBatchKey() : string
- getBoardKey() : mixed
- getButtons() : array<string|int, BoardButton>
- getButtonsContent() : mixed
- getDisplayComponentName() : mixed
- getDisplayComponentParams() : mixed
- getDisplayComponentTemplate() : mixed
- getExternalUrl() : string
- getFilter() : Filter
- getGroup() : null
- getLimitComponentName() : mixed
- getLimitComponentParams() : mixed
- getLimitComponentTemplateName() : mixed
- getMachineKey() : mixed
- getOptions() : array<string|int, mixed>
- getSliderLoader() : string|null
- getStepperIds() : mixed
- getTitle() : mixed
- isDisabled() : bool
- isExternal() : bool
- isLimited() : mixed
- isNestedInBatch() : bool
- isSliderSupport() : bool
- isStepperEnabled() : bool
- registerSetOptionsCallback() : mixed
- resetToDefault() : mixed
- Reset board to default
- resetWidgetRows() : mixed
- setBatchKey() : mixed
- setBoardKey() : mixed
- setDisabled() : mixed
- setExternal() : void
- setExternalUrl() : void
- setFilter() : mixed
- setGroup() : void
- setLimit() : mixed
- setMachineKey() : mixed
- setSliderLoader() : void
- setSliderSupport() : void
- setStepperEnabled() : mixed
- setStepperIds() : mixed
- setTitle() : mixed
- toggleOption() : mixed
Constants
REPORT_GUID
public
mixed
REPORT_GUID
= 'company_widget'
Methods
__construct()
public
__construct([string $boardId = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $boardId : string = ''
- $options : array<string|int, mixed> = []
addButton()
public
addButton(BoardButton $button) : mixed
Parameters
- $button : BoardButton
addFeedbackButton()
public
addFeedbackButton() : mixed
getBatchKey()
public
getBatchKey() : string
Return values
stringgetBoardKey()
public
getBoardKey() : mixed
getButtons()
public
getButtons() : array<string|int, BoardButton>
Return values
array<string|int, BoardButton>getButtonsContent()
public
getButtonsContent() : mixed
getDisplayComponentName()
public
getDisplayComponentName() : mixed
getDisplayComponentParams()
public
getDisplayComponentParams() : mixed
getDisplayComponentTemplate()
public
getDisplayComponentTemplate() : mixed
getExternalUrl()
public
getExternalUrl() : string
Return values
stringgetFilter()
public
getFilter() : Filter
Return values
FiltergetGroup()
public
getGroup() : null
Return values
nullgetLimitComponentName()
public
getLimitComponentName() : mixed
getLimitComponentParams()
public
getLimitComponentParams() : mixed
getLimitComponentTemplateName()
public
getLimitComponentTemplateName() : mixed
getMachineKey()
public
getMachineKey() : mixed
getOptions()
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getSliderLoader()
public
getSliderLoader() : string|null
Return values
string|nullgetStepperIds()
public
getStepperIds() : mixed
getTitle()
public
getTitle() : mixed
isDisabled()
public
isDisabled() : bool
Return values
boolisExternal()
public
isExternal() : bool
Return values
boolisLimited()
public
isLimited() : mixed
isNestedInBatch()
public
isNestedInBatch() : bool
Return values
boolisSliderSupport()
public
isSliderSupport() : bool
Return values
boolisStepperEnabled()
public
isStepperEnabled() : bool
Return values
boolregisterSetOptionsCallback()
public
registerSetOptionsCallback(callable $cb) : mixed
Parameters
- $cb : callable
resetToDefault()
Reset board to default
public
resetToDefault() : mixed
resetWidgetRows()
public
resetWidgetRows(mixed $widgetId) : mixed
Parameters
- $widgetId : mixed
setBatchKey()
public
setBatchKey(string $batchKey) : mixed
Parameters
- $batchKey : string
setBoardKey()
public
setBoardKey(mixed $boardKey) : mixed
Parameters
- $boardKey : mixed
setDisabled()
public
setDisabled(bool $disabled) : mixed
Parameters
- $disabled : bool
setExternal()
public
setExternal(bool $isExternal) : void
Parameters
- $isExternal : bool
setExternalUrl()
public
setExternalUrl(string $externalUrl) : void
Parameters
- $externalUrl : string
setFilter()
public
setFilter(Filter $filter) : mixed
Parameters
- $filter : Filter
setGroup()
public
setGroup(null $group) : void
Parameters
- $group : null
setLimit()
public
setLimit(mixed $limitComponentParams[, mixed $limit = false ]) : mixed
Parameters
- $limitComponentParams : mixed
- $limit : mixed = false
setMachineKey()
public
setMachineKey(mixed $machineKey) : mixed
Parameters
- $machineKey : mixed
setSliderLoader()
public
setSliderLoader(string $sliderLoader) : void
Parameters
- $sliderLoader : string
setSliderSupport()
public
setSliderSupport(bool $isSliderSupport) : void
Parameters
- $isSliderSupport : bool
setStepperEnabled()
public
setStepperEnabled(bool $stepperEnabled) : mixed
Parameters
- $stepperEnabled : bool
setStepperIds()
public
setStepperIds([mixed $stepperIds = [] ]) : mixed
Parameters
- $stepperIds : mixed = []
setTitle()
public
setTitle(mixed $title) : mixed
Parameters
- $title : mixed
toggleOption()
public
toggleOption(string $optionName) : mixed
Parameters
- $optionName : string