@kvaser/canking-api
Version:
CanKing API to communicate with the CanKing service using Node.js.
45 lines (44 loc) • 35 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageLoggerSettings | Kvaser CanKing GUI Extensions SDK - v7.5.1</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.5.1</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/models.html">models</a></li><li><a href="" aria-current="page">MessageLoggerSettings</a></li></ul><h1>Interface MessageLoggerSettings</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A message for defining a message logger's settings.</p>
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MessageLoggerSettings</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#autorestartafterstop">autoRestartAfterStop</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#canmessagefilter">canMessageFilter</a><span class="tsd-signature-symbol">:</span> <a href="models.CanMessageFilterSettings.html" class="tsd-signature-type tsd-kind-interface">CanMessageFilterSettings</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#colseparator">colSeparator</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.Separator.html" class="tsd-signature-type tsd-kind-enum">Separator</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#databytesconverterlimit">dataBytesConverterLimit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#decimalseparator">decimalSeparator</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.DecimalChar.html" class="tsd-signature-type tsd-kind-enum">DecimalChar</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fileconflictaction">fileConflictAction</a><span class="tsd-signature-symbol">:</span> <a href="../enums/models.FileConflictAction.html" class="tsd-signature-type tsd-kind-enum">FileConflictAction</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fileformat">fileFormat</a><span class="tsd-signature-symbol">:</span> <a href="../enums/models.LogFileFormat.html" class="tsd-signature-type tsd-kind-enum">LogFileFormat</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#filename">fileName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#numberoftimedecimals">numberOfTimeDecimals</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sizelimit">sizeLimit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#starttriggersettings">startTriggerSettings</a><span class="tsd-signature-symbol">:</span> <a href="models.TriggerSettings.html" class="tsd-signature-type tsd-kind-interface">TriggerSettings</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#starttriggersoperator">startTriggersOperator</a><span class="tsd-signature-symbol">:</span> <a href="../enums/models.TriggerOperator.html" class="tsd-signature-type tsd-kind-enum">TriggerOperator</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stoptriggersettings">stopTriggerSettings</a><span class="tsd-signature-symbol">:</span> <a href="models.TriggerSettings.html" class="tsd-signature-type tsd-kind-interface">TriggerSettings</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stoptriggersoperator">stopTriggersOperator</a><span class="tsd-signature-symbol">:</span> <a href="../enums/models.TriggerOperator.html" class="tsd-signature-type tsd-kind-enum">TriggerOperator</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#timelimit">timeLimit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#timereference">timeReference</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.TimeReference.html" class="tsd-signature-type tsd-kind-enum">TimeReference</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usecalendartime">useCalendarTime</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#useutctime">useUtcTime</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#writedatainhex">writeDataInHex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#writefileheader">writeFileHeader</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#writeidinhex">writeIdInHex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#autorestartafterstop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Restart<wbr/>After<wbr/>Stop</span></a>
<a href="#canmessagefilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Message<wbr/>Filter</span></a>
<a href="#colseparator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>col<wbr/>Separator?</span></a>
<a href="#databytesconverterlimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Bytes<wbr/>Converter<wbr/>Limit?</span></a>
<a href="#decimalseparator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimal<wbr/>Separator?</span></a>
<a href="#fileconflictaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Conflict<wbr/>Action</span></a>
<a href="#fileformat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Format</span></a>
<a href="#filename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Name</span></a>
<a href="#numberoftimedecimals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Time<wbr/>Decimals?</span></a>
<a href="#sizelimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Limit?</span></a>
<a href="#starttriggersettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Trigger<wbr/>Settings</span></a>
<a href="#starttriggersoperator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Triggers<wbr/>Operator</span></a>
<a href="#stoptriggersettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop<wbr/>Trigger<wbr/>Settings</span></a>
<a href="#stoptriggersoperator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop<wbr/>Triggers<wbr/>Operator</span></a>
<a href="#timelimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Limit?</span></a>
<a href="#timereference" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Reference?</span></a>
<a href="#usecalendartime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Calendar<wbr/>Time?</span></a>
<a href="#useutctime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Utc<wbr/>Time?</span></a>
<a href="#writedatainhex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>Data<wbr/>In<wbr/>Hex?</span></a>
<a href="#writefileheader" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>File<wbr/>Header?</span></a>
<a href="#writeidinhex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>Id<wbr/>In<wbr/>Hex?</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="autorestartafterstop"><span>auto<wbr/>Restart<wbr/>After<wbr/>Stop</span><a href="#autorestartafterstop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">autoRestartAfterStop</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>A flag indicating if the logger should auto-restart after stop. Default value is false</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canmessagefilter"><span>can<wbr/>Message<wbr/>Filter</span><a href="#canmessagefilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">canMessageFilter</span><span class="tsd-signature-symbol">:</span> <a href="models.CanMessageFilterSettings.html" class="tsd-signature-type tsd-kind-interface">CanMessageFilterSettings</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>Any filter</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="colseparator"><code class="tsd-tag">Optional</code><span>col<wbr/>Separator</span><a href="#colseparator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">colSeparator</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.Separator.html" class="tsd-signature-type tsd-kind-enum">Separator</a></div><div class="tsd-comment tsd-typography"><p>The column separator to be used. Default value is a comma (,)</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="databytesconverterlimit"><code class="tsd-tag">Optional</code><span>data<wbr/>Bytes<wbr/>Converter<wbr/>Limit</span><a href="#databytesconverterlimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dataBytesConverterLimit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Number of data bytes to max write to the log file (1-64). Default value is 8</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="decimalseparator"><code class="tsd-tag">Optional</code><span>decimal<wbr/>Separator</span><a href="#decimalseparator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">decimalSeparator</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.DecimalChar.html" class="tsd-signature-type tsd-kind-enum">DecimalChar</a></div><div class="tsd-comment tsd-typography"><p>The decimal separator to be used. Default value is a dot (.)</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fileconflictaction"><span>file<wbr/>Conflict<wbr/>Action</span><a href="#fileconflictaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fileConflictAction</span><span class="tsd-signature-symbol">:</span> <a href="../enums/models.FileConflictAction.html" class="tsd-signature-type tsd-kind-enum">FileConflictAction</a></div><div class="tsd-comment tsd-typography"><p>Name conflict action</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fileformat"><span>file<wbr/>Format</span><a href="#fileformat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fileFormat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/models.LogFileFormat.html" class="tsd-signature-type tsd-kind-enum">LogFileFormat</a></div><div class="tsd-comment tsd-typography"><p>The file format to be used</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filename"><span>file<wbr/>Name</span><a href="#filename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fileName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the file to log messages to</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="numberoftimedecimals"><code class="tsd-tag">Optional</code><span>number<wbr/>Of<wbr/>Time<wbr/>Decimals</span><a href="#numberoftimedecimals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">numberOfTimeDecimals</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Number of time decimals (0-9). Default value is 9</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sizelimit"><code class="tsd-tag">Optional</code><span>size<wbr/>Limit</span><a href="#sizelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sizeLimit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Max file size in megabytes before writing to a new file</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="starttriggersettings"><span>start<wbr/>Trigger<wbr/>Settings</span><a href="#starttriggersettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">startTriggerSettings</span><span class="tsd-signature-symbol">:</span> <a href="models.TriggerSettings.html" class="tsd-signature-type tsd-kind-interface">TriggerSettings</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Any start triggers</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="starttriggersoperator"><span>start<wbr/>Triggers<wbr/>Operator</span><a href="#starttriggersoperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">startTriggersOperator</span><span class="tsd-signature-symbol">:</span> <a href="../enums/models.TriggerOperator.html" class="tsd-signature-type tsd-kind-enum">TriggerOperator</a></div><div class="tsd-comment tsd-typography"><p>The trigger operator to be used between start triggers</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stoptriggersettings"><span>stop<wbr/>Trigger<wbr/>Settings</span><a href="#stoptriggersettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stopTriggerSettings</span><span class="tsd-signature-symbol">:</span> <a href="models.TriggerSettings.html" class="tsd-signature-type tsd-kind-interface">TriggerSettings</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Any stop triggers</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stoptriggersoperator"><span>stop<wbr/>Triggers<wbr/>Operator</span><a href="#stoptriggersoperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stopTriggersOperator</span><span class="tsd-signature-symbol">:</span> <a href="../enums/models.TriggerOperator.html" class="tsd-signature-type tsd-kind-enum">TriggerOperator</a></div><div class="tsd-comment tsd-typography"><p>The trigger operator to be used between stop triggers</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="timelimit"><code class="tsd-tag">Optional</code><span>time<wbr/>Limit</span><a href="#timelimit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">timeLimit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Max number of seconds between first and last event before writing to a new file</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="timereference"><code class="tsd-tag">Optional</code><span>time<wbr/>Reference</span><a href="#timereference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">timeReference</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/models.TimeReference.html" class="tsd-signature-type tsd-kind-enum">TimeReference</a></div><div class="tsd-comment tsd-typography"><p>Use the specified time reference. Default value is FIRST_TRIGGER</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="usecalendartime"><code class="tsd-tag">Optional</code><span>use<wbr/>Calendar<wbr/>Time</span><a href="#usecalendartime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useCalendarTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Write timestamps in calendar time instead of seconds. Default value is false</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="useutctime"><code class="tsd-tag">Optional</code><span>use<wbr/>Utc<wbr/>Time</span><a href="#useutctime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useUtcTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use UTC instead of local time for absolute timestamps. Default value is true</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="writedatainhex"><code class="tsd-tag">Optional</code><span>write<wbr/>Data<wbr/>In<wbr/>Hex</span><a href="#writedatainhex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">writeDataInHex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Write data in hexadecimal format. Default value is true</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="writefileheader"><code class="tsd-tag">Optional</code><span>write<wbr/>File<wbr/>Header</span><a href="#writefileheader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">writeFileHeader</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Write file header. Default value is true</p>
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="writeidinhex"><code class="tsd-tag">Optional</code><span>write<wbr/>Id<wbr/>In<wbr/>Hex</span><a href="#writeidinhex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">writeIdInHex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Write ID in hexadecimal format. Default value is true</p>
</div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autorestartafterstop"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Restart<wbr/>After<wbr/>Stop</span></a><a href="#canmessagefilter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Message<wbr/>Filter</span></a><a href="#colseparator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>col<wbr/>Separator</span></a><a href="#databytesconverterlimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Bytes<wbr/>Converter<wbr/>Limit</span></a><a href="#decimalseparator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>decimal<wbr/>Separator</span></a><a href="#fileconflictaction"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Conflict<wbr/>Action</span></a><a href="#fileformat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Format</span></a><a href="#filename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Name</span></a><a href="#numberoftimedecimals"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Time<wbr/>Decimals</span></a><a href="#sizelimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Limit</span></a><a href="#starttriggersettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Trigger<wbr/>Settings</span></a><a href="#starttriggersoperator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Triggers<wbr/>Operator</span></a><a href="#stoptriggersettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop<wbr/>Trigger<wbr/>Settings</span></a><a href="#stoptriggersoperator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop<wbr/>Triggers<wbr/>Operator</span></a><a href="#timelimit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Limit</span></a><a href="#timereference"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Reference</span></a><a href="#usecalendartime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Calendar<wbr/>Time</span></a><a href="#useutctime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Utc<wbr/>Time</span></a><a href="#writedatainhex"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>Data<wbr/>In<wbr/>Hex</span></a><a href="#writefileheader"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>File<wbr/>Header</span></a><a href="#writeidinhex"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write<wbr/>Id<wbr/>In<wbr/>Hex</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.5.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>