Plotly.NET/src/Plotly.NET.CSharp/ChartAPI/ChartCarpet.cs at dev · plotly/Plotly.NET

History

614 lines (607 loc) · 39.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Plotly.NET.LayoutObjects;

using Plotly.NET.TraceObjects;

using System.Runtime.InteropServices;

namespace Plotly.NET.CSharp

{

public static partial class Chart

{

/// <summary>

/// Creates a carpet in a 2D coordinate system to be used as additional coordinate system in a carpet plot.

///

/// A carpet plot illustrates the interaction between two or more independent variables and one or more dependent variables in a two-dimensional plot.

/// Besides the ability to incorporate more variables, another feature that distinguishes a carpet plot from an equivalent contour plot or 3D surface plot is that a carpet plot can be used to more accurately interpolate data points.

/// A conventional carpet plot can capture the interaction of up to three independent variables and three dependent variables and still be easily read and interpolated.

///

/// Three-variable carpet plot (cheater plot):

///

/// A carpet plot with two independent variables and one dependent variable is often called a cheater plot for the use of a phantom "cheater" axis instead of the horizontal axis. As a result of this missing axis, the values can be shifted horizontally such that the intersections line up vertically. This allows easy interpolation by having fixed horizontal intervals correspond to fixed intervals in both independent variables.

///

/// Four-variable carpet plot (true carpet plot)

///

/// Instead of using the horizontal axis to adjust the plot perspective and align carpet intersections vertically, the horizontal axis can be used to show the effects on an additional dependent variable.[5] In this case the perspective is fixed, and any overlapping cannot be adjusted. Because a true carpet plot represents two independent variables and two dependent variables simultaneously, there is no corresponding way to show the information on a conventional contour plot or 3D surface plot.

///

/// (from https://en.wikipedia.org/wiki/Carpet_plot @ 1/11/2021)

/// </summary>

/// <param name="carpetId">An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie.</param>

/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>

/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>

/// <param name="Opacity">Sets the opactity of the trace</param>

/// <param name="X">A one dimensional array of x coordinates matching the dimensions of `a` and `b`.</param>

/// <param name="MultiX">A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.</param>

/// <param name="Y">A one dimensional array of y coordinates matching the dimensions of `a` and `b`.</param>

/// <param name="MultiY">A two dimensional array of y coordinates at each carpet point.</param>

/// <param name="A">An array containing values of the first parameter value</param>

/// <param name="B">An array containing values of the second parameter value</param>

/// <param name="AAxis">Sets this carpet's a axis.</param>

/// <param name="BAxis">Sets this carpet's b axis.</param>

/// <param name="XAxis">Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to `layout.xaxis`. If "x2", the x coordinates refer to `layout.xaxis2`, and so on.</param>

/// <param name="YAxis">Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to `layout.yaxis`. If "y2", the y coordinates refer to `layout.yaxis2`, and so on.</param>

/// <param name="Color">Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.</param>

/// <param name="CheaterSlope">The shift applied to each successive row of data in creating a cheater plot. Only used if `x` is been omitted.</param>

/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>

public static GenericChart Carpet<XType, MultiXType, YType, MultiYType, AType, BType>(

string carpetId,

Optional<string> Name = default,

Optional<bool> ShowLegend = default,

Optional<double> Opacity = default,

Optional<IEnumerable<XType>> X = default,

Optional<IEnumerable<IEnumerable<MultiXType>>> MultiX = default,

Optional<IEnumerable<YType>> Y = default,

Optional<IEnumerable<IEnumerable<MultiYType>>> MultiY = default,

Optional<IEnumerable<AType>> A = default,

Optional<IEnumerable<BType>> B = default,

Optional<LinearAxis> AAxis = default,

Optional<LinearAxis> BAxis = default,

Optional<StyleParam.LinearAxisId> XAxis = default,

Optional<StyleParam.LinearAxisId> YAxis = default,

Optional<Color> Color = default,

Optional<double> CheaterSlope = default,

Optional<bool> UseDefaults = default

)

where XType : IConvertible

where MultiXType : IConvertible

where YType : IConvertible

where MultiYType : IConvertible

where AType : IConvertible

where BType : IConvertible

Plotly.NET.ChartCarpet.Chart.Carpet<XType, IEnumerable<MultiXType>, MultiXType, YType, IEnumerable<MultiYType>, MultiYType, AType, BType>(

carpetId: carpetId,

Name: Name.ToOption(),

ShowLegend: ShowLegend.ToOption(),

Opacity: Opacity.ToOption(),

X: X.ToOption(),

MultiX: MultiX.ToOption(),

Y: Y.ToOption(),

MultiY: MultiY.ToOption(),

A: A.ToOption(),

B: B.ToOption(),

AAxis: AAxis.ToOption(),

BAxis: BAxis.ToOption(),

XAxis: XAxis.ToOption(),

YAxis: YAxis.ToOption(),

Color: Color.ToOption(),

CheaterSlope: CheaterSlope.ToOption(),

UseDefaults: UseDefaults.ToOption()

);

/// <summary>

/// Creates a scatter plot that lies on a specified carpet.

///

/// In general, ScatterCarpet creates a plot that uses the given carpet identifier as coordinate system.

///

/// Whether the resulting plot is a cheater or true carpet plot depends on the referenced carpet.

///

/// ScatterCarpet charts are the basis of PointCarpet, LineCarpet, and BubbleCarpet Charts, and can be customized as such. We also provide abstractions for those: Chart.LineCarpet, Chart.PointCarpet, Chart.BubbleCarpet

/// </summary>

/// <param name="a">Sets the a-axis coordinates on the carpet.</param>

/// <param name="b">Sets the b-axis coordinates on the carpet.</param>

/// <param name="mode">Determines the drawing mode for this scatter trace. If the provided `mode` includes "text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".</param>

/// <param name="carpetAnchorId">The identifier of the carpet that this trace will lie on.</param>

/// <param name="Name">Sets the trace name. The trace name appear as the legend item and on hover</param>

/// <param name="ShowLegend">Determines whether or not an item corresponding to this trace is shown in the legend.</param>

/// <param name="Opacity">Sets the opactity of the trace</param>

/// <param name="MultiOpacity">Sets the opactity of individual datum markers</param>

/// <param name="Text">Sets a text associated with each datum</param>

/// <param name="MultiText">Sets individual text for each datum</param>

/// <param name="TextPosition">Sets the position of text associated with each datum</param>

/// <param name="MultiTextPosition">Sets the position of text associated with individual datum</param>

/// <param name="MarkerColor">Sets the color of the marker</param>

/// <param name="MarkerColorScale">Sets the colorscale of the marker</param>

/// <param name="MarkerOutline">Sets the outline of the marker</param>

/// <param name="MarkerSymbol">Sets the marker symbol for each datum</param>

/// <param name="MultiMarkerSymbol">Sets the marker symbol for each individual datum</param>

/// <param name="Marker">Sets the marker (use this for more finegrained control than the other marker-associated arguments)</param>

/// <param name="LineColor">Sets the color of the line</param>

/// <param name="LineColorScale">Sets the colorscale of the line</param>

/// <param name="LineWidth">Sets the width of the line</param>

/// <param name="LineDash">sets the drawing style of the line</param>

/// <param name="Line">Sets the line (use this for more finegrained control than the other line-associated arguments)</param>

/// <param name="UseDefaults">If set to false, ignore the global default settings set in `Defaults`</param>

public static GenericChart ScatterCarpet<AType, BType, TextType>(

IEnumerable<AType> a,

IEnumerable<BType> b,

StyleParam.Mode mode,

string carpetAnchorId,

Optional<string> Name = default,

Optional<bool> ShowLegend = default,

Optional<double> Opacity = default,

Optional<IEnumerable<double>> MultiOpacity = default,

Optional<TextType> Text = default,

Optional<IEnumerable<TextType>> MultiText = default,

Optional<StyleParam.TextPosition> TextPosition = default,

Optional<IEnumerable<StyleParam.TextPosition>> MultiTextPosition = default,

Optional<Color> MarkerColor = default,

Optional<StyleParam.Colorscale> MarkerColorScale = default,

Optional<Line> MarkerOutline = default,

Optional<StyleParam.MarkerSymbol> MarkerSymbol = default,

Optional<IEnumerable<StyleParam.MarkerSymbol>> MultiMarkerSymbol = default,

Optional<Marker> Marker = default,

Optional<Color> LineColor = default,

Optional<StyleParam.Colorscale> LineColorScale = default,

Optional<double> LineWidth = default,

Optional<StyleParam.DrawingStyle> LineDash = default,

Optional<Line> Line = default,

Optional<bool> UseDefaults = default

)

where AType : IConvertible

where BType : IConvertible

where TextType : IConvertible

Plotly.NET.ChartCarpet.Chart.ScatterCarpet<AType, BType, TextType>(

a: a,

b: b,

mode: mode,

carpetAnchorId: carpetAnchorId,

Name: Name.ToOption(),

ShowLegend: ShowLegend.ToOption(),

Opacity: Opacity.ToOption(),

MultiOpacity: MultiOpacity.ToOption(),

Text: Text.ToOption(),

MultiText: MultiText.ToOption(),

TextPosition: TextPosition.ToOption(),

MultiTextPosition: MultiTextPosition.ToOption(),

MarkerColor: MarkerColor.ToOption(),

MarkerColorScale: MarkerColorScale.ToOption(),

MarkerOutline: MarkerOutline.ToOption(),

MarkerSymbol: MarkerSymbol.ToOption(),

MultiMarkerSymbol: MultiMarkerSymbol.ToOption(),

Marker: Marker.ToOption(),

LineColor: LineColor.ToOption(),

LineColorScale: LineColorScale.ToOption(),

LineWidth: LineWidth.ToOption(),

LineDash: LineDash.ToOption(),

Line: Line.ToOption(),

UseDefaults: UseDefaults.ToOption()

);

/// <summary>

/// Creates a point plot that lies on a specified carpet.

///

/// In general, PointCarpet creates a point plot that uses the given carpet identifier as coordinate system.